Skip to content

Commit a6bd04c

Browse files
derek73claude
andcommitted
docs: input shapes use the 2.0 field names
The three patterns were lifted from v1's README verbatim, v1 vocabulary included, so a page teaching given/family described its input shapes in first/middle/last. That undercuts the rename the API is built on. Restoring the names also recovered detail the first pass had trimmed: v1's forms distinguish a comma that separates the family name (form 2, family-first) from a comma that only sets off suffixes (form 3, still given-then-family). That distinction is the whole reason both forms are listed, so it is now stated and pinned with a third doctest. The nickname and pre-comma suffix slots are back in the patterns too, the latter matching the "Doe Jr., John" example already there. Checked the rest of the 2.0 docs for the same slip; this was the only occurrence outside migrate.rst, where v1 names are the subject. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 4dd99c1 commit a6bd04c

1 file changed

Lines changed: 11 additions & 7 deletions

File tree

docs/usage.rst

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,19 +33,23 @@ Input shapes
3333

3434
Three arrangements are understood, and every piece of each is optional:
3535

36-
1. ``Title First Middle Middle Last Suffix``
37-
2. ``Last, Title First Middle Middle[,] Suffix [, Suffix]``
38-
3. ``Title First Middle Last [,] Suffix [, Suffix]``
36+
1. ``Title Given "Nickname" Middle Middle Family Suffix``
37+
2. ``Family [Suffix], Title Given (Nickname) Middle Middle[,] Suffix [, Suffix]``
38+
3. ``Title Given Middle Family [Suffix], Suffix [, Suffix]``
3939

40-
A comma before the given name is the signal for family-first order, so
41-
the second form needs no configuration:
40+
The last two differ in what the comma is doing. In form 2 it separates
41+
the family name from the rest, so the family name comes first; in form
42+
3 it only sets off suffixes, and the name before it is still
43+
given-then-family:
4244

4345
.. doctest::
4446

45-
>>> parse("de la Vega, Juan Q. Xavier III").family
47+
>>> parse("de la Vega, Juan Q. Xavier III").family # form 2
4648
'de la Vega'
47-
>>> parse("Doe Jr., John").suffix
49+
>>> parse("Doe Jr., John").suffix # form 2, suffix before the comma
4850
'Jr.'
51+
>>> parse("John Doe, Jr.").family # form 3
52+
'Doe'
4953

5054
For family-first input *without* a comma — common outside Europe — set
5155
``name_order``; see :doc:`customize`.

0 commit comments

Comments
 (0)