Skip to content

Fix stale maiden-field docs in index.rst and CONTRIBUTING.md #251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
derek73 merged 2 commits into from
Jul 6, 2026
Merged

Fix stale maiden-field docs in index.rst and CONTRIBUTING.md #251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6269c6a
Update docs for the maiden field (#22) that never got documented
derek73 Jul 6, 2026
74337fb
Lowercase the CONTRIBUTING.md example input so capitalize() has visib…
derek73 Jul 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,26 @@ Run a single test file or test:

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

$ python -m nameparser "Secretary of State Hillary Rodham-Clinton"
$ python -m nameparser "secretary of state hillary rodham-clinton"
<HumanName : [
title: 'secretary of state'
first: 'hillary'
middle: ''
last: 'rodham-clinton'
suffix: ''
nickname: ''
maiden: ''
]>
<HumanName : [
title: 'Secretary of State'
first: 'Hillary'
middle: ''
last: 'Rodham-Clinton'
suffix: ''
nickname: ''
maiden: ''
]>
Initials: H. R.

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

Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ components.
* hn.last
* hn.suffix
* hn.nickname
* hn.maiden

Supports 3 different comma placement variations in the input string.

Expand Down
Loading