Fix stale maiden-field docs in index.rst and CONTRIBUTING.md#251
Merged
Conversation
docs/index.rst's attribute list and CONTRIBUTING.md's debug-CLI example output both predate the maiden field added in 1.3.0 -- every HumanName repr has included it since, but these two docs were never updated to match. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #251 +/- ##
=======================================
Coverage 97.52% 97.52%
=======================================
Files 13 13
Lines 888 888
=======================================
Hits 866 866
Misses 22 22 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
…le effect The name was already properly capitalized, so the second repr (after .capitalize()) was identical to the first -- didn't actually demonstrate what the CLI's capitalize step does. Co-Authored-By: Claude Sonnet 5 <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
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
maidenfield was added toHumanNamein 1.3.0 (closes Alternate last name in parentheses is parsed into nickname field #22) — everyHumanNamerepr has included it since, but two docs were never updated to match:docs/index.rst: the attribute bullet list was missinghn.maiden.CONTRIBUTING.md: thepython -m nameparser "..."debug-CLI example output was stale in three ways versus whatnameparser/__main__.pyactually prints — missing themaiden: ''repr line, missing the secondrepr()block (the CLI calls.capitalize()and prints again), and missing the trailingInitials: H. R.line.python -m nameparser "Secretary of State Hillary Rodham-Clinton", matching the file's existing indentation (4 spaces + tab per field).Test plan
python -m nameparser "Secretary of State Hillary Rodham-Clinton"output matches CONTRIBUTING.md verbatimuv run sphinx-build -b doctest docs <tmpdir>— 191 tests, 0 failuresuv run sphinx-build -b html docs <tmpdir>— build succeededpytest— 1438 passed, 4 skipped, 22 xfailed