AGENTS.md: the attribute-docstring doctest paragraph is v1 history - #545
Merged
Merged
Conversation
The paragraph said tests/test_config_attribute_docstrings.py (#195) recovers doctests from Constants attribute docstrings with ast and runs them. Both halves are gone: since the M11 swap the real Constants lives in _config_shim.py with bare type annotations and no attribute docstrings, and the test was deleted in M12 (a689e1d) because its AST walk found no class in the re-export shim and nothing to run in the real one. The paragraph now says so, in the file's 2.0-note form, and points a future example at a unit test per the lean-docs rule. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #545 +/- ##
=======================================
Coverage 98.78% 98.78%
=======================================
Files 45 45
Lines 3703 3703
=======================================
Hits 3658 3658
Misses 45 45 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
One paragraph of AGENTS.md (the Doctests gotcha, line ~405) still described
tests/test_config_attribute_docstrings.py(#195) as the mechanism that runs.. doctest::examples insideConstantsattribute docstrings. Neither half exists: since the M11 swap the realConstantslives innameparser/_config_shim.pywith bare type annotations (patronymic_name_order: bool) and no attribute docstrings, and the test was deleted in M12 (a689e1d8) because its AST walk found no class in the re-export shim and nothing to run in the real one.The paragraph is rewritten in the file's "2.0 note" form: the v1 mechanism and why it existed stay as history, the deletion and its reason are stated, and a future attribute example is pointed at a unit test per the lean-docs rule. No code, no tests.
Found while landing #543 (a fix-round implementer tried to run the cited file). Docs only;
uv run ruff check .unaffected.🤖 Generated with Claude Code