docs: correct AGENTS.md note on which doctests actually run#181
Merged
Conversation
The note claimed docs/usage.rst doctests run under 'uv run pytest', but testpaths is tests+nameparser only and there is no --doctest-glob, so .rst doctests run under neither pytest nor CI (CI does sphinx -b html, not -b doctest). Document how to verify .rst examples manually and flag the pre-existing customize.rst failures. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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
The AGENTS.md gotcha claimed
docs/usage.rstdoctests run underuv run pytest(--doctest-modules). That's inaccurate:testpathsistests+nameparseronly and there's no--doctest-glob, so the.rstdoctests indocs/run under neither pytest nor CI (CI doessphinx-build -b html, not-b doctest). Following that note for verification gives false confidence.Replaced it with an accurate description:
nameparser/*.pydo run under pytest..rstdoctests must be verified manually (documents the exactdoctest.testfile(..., NORMALIZE_WHITESPACE)command).customize.rstfailures under-b doctest(CONSTANTS state leaks across examples with no per-example reset; non-deterministicSetManagerrepr).Verification
The documented manual command runs as described.
🤖 Generated with Claude Code