Skip to content

docs: list __version__ in the Python README's API section - #10

Merged
dmccoystephenson merged 1 commit into
mainfrom
docs/readme-api-version
Sep 22, 2026
Merged

dmccoystephenson merged 1 commit into
mainfrom
docs/readme-api-version

Conversation

@dmccoystephenson

Copy link
Copy Markdown
Contributor

Summary

Half touched: python/ only, and only its README. No source, test, manifest, or workflow file is changed.

Test plan

  • python/README.md API list compared line-by-line against __all__ in python/src/github_docs/__init__.py — every entry in __all__ now has a README line and vice versa.
  • CI green on the PR head (docs-only change; the local test anchor was not run because the sandbox's interpreter is Python 3.8, below the package's 3.9 floor — recorded as UNVERIFIED-not-applicable since no anchor-covered file is modified).

Deferred this cycle

Closes #9

This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).

🤖 Generated with Claude Code


drafted by Claude on behalf of Daniel Stephenson

The README's API list and the package's __all__ were otherwise
symbol-for-symbol identical; __version__ was the one entry in __all__
the list did not carry. Add it so the correspondence is kept on purpose
rather than lost by accident.

Closes #9

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@dmccoystephenson

Copy link
Copy Markdown
Contributor Author

Self-review rubric (scored against the diff and the CI run on head 3ed8eaa):

  • Scope: PASS — one file modified (python/README.md), one line added; nothing outside the __version__ is exported from the Python package but is absent from the README's API list #9 surface area is touched.
  • Tests-new: no signal — no public method or function is added.
  • Tests-fix: no signal — documentation correction, not a bug fix; there is no production behaviour to revert.
  • Sibling structure: PASS — the new bullet follows the - \symbol` — description.` shape used by the surrounding API entries.
  • Sibling renames: no signal — nothing is renamed.
  • Docs: PASS — python/README.md API list now matches __all__ in python/src/github_docs/__init__.py entry-for-entry (8 entries each). README.md, js/README.md, both manifests, ci.yml, and js/src/index.ts are unaffected by this change.
  • Issue resolution: PASS — __version__ is exported from the Python package but is absent from the README's API list #9 names exactly this gap and offers two resolutions; the first (add the README line) is implemented in full, and __all__ is deliberately left as it was.
  • CI: PASS — all 8 legs (js 18/20/22, python 3.9–3.13) green on the PR head. The local anchor was not run (the sandbox interpreter is Python 3.8, below the 3.9 floor), recorded as UNVERIFIED-not-applicable because no anchor-covered file is modified.

Repo-specific items:

  • No-leak (js) / Result-not-exception / No runtime dependency (js) / Export parity / Support-matrix parity: no signal — no js/ file or manifest is changed.
  • No-leak (python): no signal — no GitHubDocsError message is added or changed.
  • Stdlib-only: PASS — python/pyproject.toml is untouched; dependencies = [] stands.
  • Sentinel intact: PASS — python/tests/test_client.py is untouched.

Out-of-diff observation: the phrase "matching pyproject.toml" in the new line is a claim that has to stay true by hand — __version__ in __init__.py and version in pyproject.toml are two literals with nothing tying them together. Both read 0.1.0 today. A release-time bump that touches only one would make the README's new line wrong; this is noted rather than fixed because a version bump is an owner decision and wiring the two together is not docs work.

No item scored FAIL; nothing to address in Phase 6.

This review comment was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).


drafted by Claude on behalf of Daniel Stephenson

@dmccoystephenson
dmccoystephenson merged commit 7596f60 into main Sep 22, 2026
16 checks passed
@dmccoystephenson
dmccoystephenson deleted the docs/readme-api-version branch September 22, 2026 07:55
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.

__version__ is exported from the Python package but is absent from the README's API list

1 participant