__version__ is exported from the package but is absent from the README's API list.
python/src/github_docs/__init__.py:30 defines __version__ = "0.1.0", and line 27 lists "__version__" in __all__, so from github_docs import __version__ is a supported import and from github_docs import * brings it in.
The API section of python/README.md:120-132 enumerates the public surface — GitHubDocsConfig, GitHubDocsClient and its methods, Document, DocumentSummary, SaveResult, GitHubDocsError, slugify_path — and that list is otherwise an exact match for __all__. __version__ is the one entry in __all__ that the list does not carry.
The gap is small, and the argument for leaving it alone is real: __version__ is a convention rather than API in the sense the rest of that list means. It is recorded because the two lists are otherwise symbol-for-symbol identical, which is a property worth either keeping or deliberately abandoning rather than losing by accident. The npm half's README has no equivalent entry to compare against, since the TypeScript package exposes no version constant.
Two ways this could be settled:
- Add a line to the README's API list, keeping the two lists in exact correspondence.
- Drop
"__version__" from __all__, leaving the attribute importable by name but out of the starred import, and leave the README as it is.
Either resolves it; the first is the smaller change and the second is the more opinionated one.
This was noticed during a documentation-accuracy sweep run as part of a development cycle, and was deliberately kept out of the test-only PR that cycle produced (#8).
This issue was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).
drafted by Claude on behalf of Daniel Stephenson
__version__is exported from the package but is absent from the README's API list.python/src/github_docs/__init__.py:30defines__version__ = "0.1.0", and line 27 lists"__version__"in__all__, sofrom github_docs import __version__is a supported import andfrom github_docs import *brings it in.The API section of
python/README.md:120-132enumerates the public surface —GitHubDocsConfig,GitHubDocsClientand its methods,Document,DocumentSummary,SaveResult,GitHubDocsError,slugify_path— and that list is otherwise an exact match for__all__.__version__is the one entry in__all__that the list does not carry.The gap is small, and the argument for leaving it alone is real:
__version__is a convention rather than API in the sense the rest of that list means. It is recorded because the two lists are otherwise symbol-for-symbol identical, which is a property worth either keeping or deliberately abandoning rather than losing by accident. The npm half's README has no equivalent entry to compare against, since the TypeScript package exposes no version constant.Two ways this could be settled:
"__version__"from__all__, leaving the attribute importable by name but out of the starred import, and leave the README as it is.Either resolves it; the first is the smaller change and the second is the more opinionated one.
This was noticed during a documentation-accuracy sweep run as part of a development cycle, and was deliberately kept out of the test-only PR that cycle produced (#8).
This issue was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).
drafted by Claude on behalf of Daniel Stephenson