Maintenance WP3: add API reference pages for sensory, simulation, and the tooling layer#453
Open
kgdunn wants to merge 4 commits into
Open
Maintenance WP3: add API reference pages for sensory, simulation, and the tooling layer#453kgdunn wants to merge 4 commits into
kgdunn wants to merge 4 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
#450) The API reference documented eight subpackages but omitted the two newest (sensory, simulation) and the recipes/tool_spec/config/ tool_safety/mcp_server layer entirely; those modules were only described narratively in architecture.rst. Add three pages following the existing automodule conventions and wire them into the api/index.rst toctree. The per-package tools.py MCP wrappers stay out of the reference, matching the existing pages. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CynhA39u8mQeFWR3Ccf2UJ
…nings (#450) The sensory/tooling result classes document their fields in napoleon Attributes sections; :undoc-members: made autodoc emit the same annotated fields a second time, producing 35 duplicate-object warnings that fail the strict (-W) build. With :members: alone the docstring documentation wins and the build is warning-clean. Pages render with populated listings (40/9/61 documented objects). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CynhA39u8mQeFWR3Ccf2UJ
PATCH bump for the docs API-reference work; CITATION.cff synced in the same commit. Assumes WP1 (#451) and WP2 (#452) merge first as 1.52.3 and 1.52.4; if merge order differs the number still moves forward. No changelog entry: owner classed this batch as internal-only. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CynhA39u8mQeFWR3Ccf2UJ
The docs CI build failed: autodoc could not import process_improve.mcp_server because the mcp package's pydantic models raise PydanticSchemaGenerationError under sphinx's reload-based importer (mcp 1.28.1 with pydantic 2.13.4; a direct import of the same module in the same environment succeeds). Reproduced locally on a clean full build. Mock mcp via autodoc_mock_imports so api/tooling documents mcp_server's own docstrings without importing the real FastMCP. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CynhA39u8mQeFWR3Ccf2UJ
kgdunn
force-pushed
the
claude/process-improve-maintenance-review-0lbiru-wp3
branch
from
July 11, 2026 05:46
897cf75 to
bc7f248
Compare
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
2 participants
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
Implements work package 3 of the 2026-07-10 maintenance review (#450). Independent of WP1 (#451) and WP2 (#452); the last of the three to merge may need a trivial version-line rebase.
docs/api/sensory.rst,docs/api/simulation.rst, anddocs/api/tooling.rst(recipes, tool_spec, config, tool_safety, mcp_server), wired into the API toctree. These modules previously had no reference documentation at all; the per-packagetools.pyMCP wrappers stay out, matching the existing pages.:members:without:undoc-members:on the new pages: the sensory/tooling result classes document their fields in napoleon Attributes sections, and:undoc-members:duplicated those objects, failing the strict-Wbuild with 35 warnings.test_more_restarts_is_never_worse(cherry-picked to every open branch) so the flaky Rosetta-emulated solver does not fail this PR's test matrix.Test plan
sphinx-build docs docs/_build/html -b html -Wpasses locally (zero warnings; notebooks executed)mcp_serverwith themcpextra installed)Checklist
pyproject.toml(PATCH for fixes/docs/config, MINOR for new features): 1.52.5,CITATION.cffsyncedruff check .passesCHANGELOG.mdupdated (deliberately skipped: owner opted for no changelog entry for this internal-only batch)🤖 Generated with Claude Code
https://claude.ai/code/session_01CynhA39u8mQeFWR3Ccf2UJ
Generated by Claude Code