docs: expose public package surface in API overview#103
Merged
Conversation
The reference overview rendered the top-level haclient package with show_submodules: false and members: false, hiding the public import contract defined by haclient.__init__.__all__. Add a hand-written table mapping every name in __all__ to its reference page so users get a clear, discoverable overview of HAClient, SyncHAClient, ConnectionConfig, DomainSpec, Entity, the exception types, and the rest of the public surface. Refs #94
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #94
Issue validity
Valid.
docs/reference/index.mdrendered the top-levelhaclientpackage withshow_submodules: falseandmembers: false, hiding the public import contract defined byhaclient/__init__.py(__all__). Users had no discoverable overview of common imports likeHAClient,SyncHAClient,ConnectionConfig,DomainSpec,Entity, or the exception types.Fix
Following the issue's suggested option of a hand-written table (keeps the page focused and avoids duplicating per-symbol docs that already live on dedicated reference pages):
docs/reference/index.mdmapping every name inhaclient.__all__to the reference page where it is documented.::: haclientblock for the package-level docstring.Checks run
pytest tests/ --cov=haclient --cov-report=term-missing --cov-fail-under=95— 329 passed, coverage 97.19%ruff check src tests— all checks passedruff format --check src tests— 60 files already formattedmypy src— no issues in 38 source filesmkdocs build— built cleanly