Skip to content

Commit a3b8743

Browse files
derek73claude
andauthored
Fix stale maiden-field docs in index.rst and CONTRIBUTING.md (#251)
* Update docs for the maiden field (#22) that never got documented 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> * Lowercase the CONTRIBUTING.md example input so capitalize() has visible 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> --------- Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
1 parent c5a9fac commit a3b8743

2 files changed

Lines changed: 13 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,26 @@ Run a single test file or test:
2020

2121
You can also pass a name string to see how it will be parsed:
2222

23-
$ python -m nameparser "Secretary of State Hillary Rodham-Clinton"
23+
$ python -m nameparser "secretary of state hillary rodham-clinton"
24+
<HumanName : [
25+
title: 'secretary of state'
26+
first: 'hillary'
27+
middle: ''
28+
last: 'rodham-clinton'
29+
suffix: ''
30+
nickname: ''
31+
maiden: ''
32+
]>
2433
<HumanName : [
2534
title: 'Secretary of State'
2635
first: 'Hillary'
2736
middle: ''
2837
last: 'Rodham-Clinton'
2938
suffix: ''
3039
nickname: ''
40+
maiden: ''
3141
]>
42+
Initials: H. R.
3243

3344
CI runs tests against Python 3.10–3.14 via GitHub Actions on every push and pull request.
3445

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ components.
1717
* hn.last
1818
* hn.suffix
1919
* hn.nickname
20+
* hn.maiden
2021

2122
Supports 3 different comma placement variations in the input string.
2223

0 commit comments

Comments
 (0)