Skip to content

AGENTS.md: the attribute-docstring doctest paragraph is v1 history - #545

Merged
derek73 merged 1 commit into
masterfrom
claude/agents-md-attribute-docstring-note
Sep 26, 2026
Merged

derek73 merged 1 commit into
masterfrom
claude/agents-md-attribute-docstring-note

Conversation

@derek73

@derek73 derek73 commented Sep 26, 2026

Copy link
Copy Markdown
Owner

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 inside Constants attribute docstrings. Neither half exists: since the M11 swap the real Constants lives in nameparser/_config_shim.py with 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

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>
@derek73 derek73 added this to the 2.4 milestone Sep 26, 2026
@derek73 derek73 added the docs Documentation fixes and updates label Sep 26, 2026
@derek73 derek73 self-assigned this Sep 26, 2026
@codecov

codecov Bot commented Sep 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.78%. Comparing base (e3be17a) to head (4c8b93e).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@derek73
derek73 merged commit e0f1a2f into master Sep 26, 2026
11 checks passed
@derek73
derek73 deleted the claude/agents-md-attribute-docstring-note branch September 26, 2026 05:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation fixes and updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant