Skip to content

[S9] Document supported APIs and audit compatibility surface #159

Open

Description

Build on the completed S8 settings/routing foundation without changing runtime behavior.

Deliverables

  • S9a — Supported architecture and adoption docs: Document the typed extension definition → activation facade → lifecycle hooks path and the Python ToolServer public facade. Explain extension/shared-library ownership, configuration boundaries, and why _settings/_routing remain private implementation details. Show the supported adoption path while preserving isort’s manual-lifecycle, lower-level APIs.
  • S9b — Compatibility audit: Record actual imports and usage across Black, Flake8, isort, mypy, and Pylint, including the reviewed revisions. Use that evidence to identify genuinely superseded entry points; add conservative compatibility/deprecation annotations only where justified, with replacement guidance. Do not infer that an API is unused.

Acceptance and exclusions

Docs and audit must agree with the supported surface; any proposed deprecation must cite consumer evidence and preserve existing callers. Start these as independent workstreams; introduce a dependency only if implementation demonstrates one. No removals or runtime behavior changes. Exclude deferred S4 (#143), layout/directory moves, dependency upgrades, and lifecycle/execution rewrites.

Activity

  1. edvilme commented on Nov 17, 2026

    @edvilme
    ContributorAuthor

    S9 scope update (maintainer-approved): The five-consumer compatibility audit is complete and found no justified deprecations. Its full revision-linked evidence is preserved in the PR discussion, rather than becoming a permanent repository document.

    #162 will be closed without merging. #161 remains the only proposed S9 repository change and is being left open and unmerged, as requested. Existing manual lifecycles and lower-level APIs remain supported; no runtime changes are needed. This issue stays open for the documentation work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    debtCode Cleanup, Refactorings and Repo health. Not feature relatedtriage-needed

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions