Skip to content

Define and stabilize base_cli public API exports and docs - #1748

Merged
codeforester merged 1 commit into
mainfrom
enhancement/1745-20260723-public-api
Jul 23, 2026
Merged

Define and stabilize base_cli public API exports and docs#1748
codeforester merged 1 commit into
mainfrom
enhancement/1745-20260723-public-api

Conversation

@codeforester

Copy link
Copy Markdown
Collaborator

Summary

  • Re-export command filters, command protocol helpers, and user configuration types from base_cli.
  • Add explicit __all__ declarations for the public command/filter/protocol/history surfaces.
  • Add entry-point docstrings for App, Context, and run_app.
  • Document the supported facade and add public API regression tests.

Root Cause

Several structured APIs were only reachable through internal-looking module paths, while history implicitly exposed low-level helpers through wildcard import behavior. The main entry points also lacked docstrings for IDE and generated documentation consumers.

Validation

  • Focused public API/protocol tests: 63 passed, 4 subtests passed.
  • Full Python suite: 1050 passed, 1 skipped, 251 subtests passed.
  • Focused Pylint: clean.
  • git diff --check.

Fixes #1745

@codeforester
codeforester requested a review from a team as a code owner July 23, 2026 23:14
@codeforester
codeforester merged commit 6d8f19a into main Jul 23, 2026
28 checks passed
@codeforester
codeforester deleted the enhancement/1745-20260723-public-api branch July 23, 2026 23:20
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.

Define and stabilize base_cli public API exports and docs

1 participant