Document exported public API surface - #184
Merged
codeforester merged 2 commits intoAug 8, 2026
Merged
Conversation
codeforester
deleted the
documentation/179-20260808-document-public-api-surface
branch
August 8, 2026 18:18
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
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.
Summary
The affected modules are part of the supported public surface. Explicit
docstrings make generated API references useful and the test guard prevents
future exported symbols from silently shipping without documentation.
Fixes #179
Validation
.venv/bin/python -m pytest -q(404 passed).venv/bin/python -m pytest -q tests/test_public_api.py(6 passed).venv/bin/python -m mypy --strict lib/python/base_cli.venv/bin/ruff format --check lib/python/base_cli/history.py lib/python/base_cli/command_protocol.py lib/python/base_cli/context.py tests/test_public_api.py.venv/bin/ruff check lib/python/base_cli/history.py lib/python/base_cli/command_protocol.py lib/python/base_cli/context.py tests/test_public_api.py.venv/bin/python scripts/validate_docs.py.venv/bin/python scripts/validate_examples.pygit diff --check