Skip to content

Document exported public API surface - #184

Merged
codeforester merged 2 commits into
mainfrom
documentation/179-20260808-document-public-api-surface
Aug 8, 2026
Merged

Document exported public API surface#184
codeforester merged 2 commits into
mainfrom
documentation/179-20260808-document-public-api-surface

Conversation

@codeforester

Copy link
Copy Markdown
Contributor

Summary

  • document the exported history, command-protocol, and context symbols
  • add a regression guard requiring docstrings on exported public callables and classes
  • record the public API documentation improvements in the unreleased changelog

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.py
  • git diff --check

@codeforester
codeforester merged commit b9c1301 into main Aug 8, 2026
81 checks passed
@codeforester
codeforester deleted the documentation/179-20260808-document-public-api-surface branch August 8, 2026 18:18
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.

~23 public API functions in history.py, command_protocol.py, and context.py have no docstrings

1 participant