Skip to content

Commit 6269c6a

Browse files
derek73claude
andcommitted
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>
1 parent c5a9fac commit 6269c6a

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,18 @@ You can also pass a name string to see how it will be parsed:
2828
last: 'Rodham-Clinton'
2929
suffix: ''
3030
nickname: ''
31+
maiden: ''
3132
]>
33+
<HumanName : [
34+
title: 'Secretary of State'
35+
first: 'Hillary'
36+
middle: ''
37+
last: 'Rodham-Clinton'
38+
suffix: ''
39+
nickname: ''
40+
maiden: ''
41+
]>
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)