Skip to content

docs: tidy comments, docstrings and the STATUS caveats - #14

Draft
planetf1 wants to merge 2 commits into
feat/image-variants-and-build-argsfrom
docs/tidy-comments-and-docs
Draft

planetf1 wants to merge 2 commits into
feat/image-variants-and-build-argsfrom
docs/tidy-comments-and-docs

Conversation

@planetf1

Copy link
Copy Markdown
Collaborator

Comments and docstrings are shorter and no longer use dashes as separators. No behaviour change: the AST of every touched Python file is identical once docstrings are removed, and the suite passes (226 passed, 4 skipped). docs/STATUS.md gets the Decision Index caveats split into short bullets.

Stacked on #13 (base is its branch) so the two do not conflict; retarget to main after #13 merges. Draft.

Comments and docstrings only; the AST of every touched file is unchanged
once docstrings are removed, and the suite passes (226 passed, 4 skipped).

Assisted-by: Claude Code
Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
Assisted-by: Claude Code
Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant