Skip to content

Commit 8c48fc2

Browse files
derek73claude
andcommitted
docs: fix what the second review round found in the usage.rst fixes
- The facade's initials() asks its vocabulary about particles as well as conjunctions, so a spliced "de la" gives no initials there (J. V. S. against the core's J. d. l. V. S.); "likewise asks only the conjunction question" was the first round's own error. - "Two or more NAME words, a title not counting" was too narrow: a suffix word counts toward the two ("John Jr ma" reads the credential) and a nickname does not ('John "Jack" ma' keeps the surname). Now "two or more words, not counting a title or a nickname", in usage.rst and customize.rst alike. - "So are particles:" read as "particles are something the parse records"; now "Particles are a second exception:". - "Two more by the script they are written in" was wrong for form 7, which the divider carries, not the script; now "by how they are written". - Rewraps two hand-wrapped customize.rst passages left uneven. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 parent 0b05473 commit 8c48fc2

2 files changed

Lines changed: 17 additions & 17 deletions

File tree

‎docs/customize.rst‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -300,9 +300,9 @@ The full reading of a bare marked acronym, in order:
300300
the family name even WITH words to spare (``"John Smith Ma"``).
301301
- **No signal** — all lowercase in a mixed-case name, or any spelling
302302
in a name written wholly in one case — falls back to the count: a
303-
suffix with two or more name words before it, a title not counting
304-
(``"John Smith ma"``), the
305-
family name otherwise (``"JACK MA"``).
303+
suffix with two or more words before it, not counting a title or a
304+
nickname (``"John Smith ma"``), the family name otherwise
305+
(``"JACK MA"``).
306306
- **After a comma** the count of name words before the comma decides
307307
FIRST, and the case is read only where the count leaves the word a
308308
name. ``"John Smith, Ba"`` reads suffix ``Ba`` on the count alone, and
@@ -578,8 +578,9 @@ Family-first name order
578578
``name_order`` is the one most likely to matter for data that is not
579579
in Western order. Positional input is assigned in the order you
580580
declare — with the two vocabulary exceptions noted under
581-
:ref:`order-vocabulary-first` — so a name written family-first — Hungarian, here — parses as
582-
written instead of needing to be rearranged afterwards:
581+
:ref:`order-vocabulary-first` — so a name written family-first —
582+
Hungarian, here — parses as written instead of needing to be
583+
rearranged afterwards:
583584

584585
.. doctest::
585586

‎docs/usage.rst‎

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,7 @@ Input shapes
3232
-------------
3333

3434
Three arrangements are understood by default, two more when you
35-
declare a family-first order, and two more by the script they are
36-
written in.
35+
declare a family-first order, and two more by how they are written.
3736

3837
Understood by default
3938
~~~~~~~~~~~~~~~~~~~~~
@@ -914,8 +913,8 @@ Which reading a bare one gets depends on what the writing says:
914913
- **Any other cased spelling** that is not wholly lowercase leans to
915914
the surname, even with words to spare (``Jack Ma``, ``John Smith Ma``).
916915
- **No signal** — all lowercase, or a name written wholly in one
917-
case — leaves it to the count: the credential with two or more name
918-
words before it (a title does not count), the surname otherwise.
916+
case — leaves it to the count: the credential with two or more words
917+
before it, not counting a title or a nickname, the surname otherwise.
919918

920919
Either way the choice is recorded:
921920

@@ -1034,11 +1033,11 @@ honor, so each view falls back on what it can answer without one:
10341033
capitals wherever the field is the suffix, so ``replace(suffix="mba")``
10351034
repairs to ``MBA`` and ``suffix="vi"`` to ``VI``. A credential
10361035
recognised only by its dotted shape is the exception, since the shape
1037-
is something the parse records. So are particles: whether a particle
1038-
is acting as one is a fact about the whole part, and no word of a
1039-
spliced field carries a reading to derive it from, so a family set to
1040-
``de la`` stays lowercase where the same words parsed are repaired to
1041-
``De La``.
1036+
is something the parse records. Particles are a second exception:
1037+
whether a particle is acting as one is a fact about the whole part,
1038+
and no word of a spliced field carries a reading to derive it from,
1039+
so a family set to ``de la`` stays lowercase where the same words
1040+
parsed are repaired to ``De La``.
10421041
- :meth:`~nameparser.ParsedName.initials` takes no vocabulary at all,
10431042
so every word of a spliced field contributes an initial.
10441043
- ``family_particles`` and ``family_base`` are properties on the
@@ -1048,9 +1047,9 @@ honor, so each view falls back on what it can answer without one:
10481047

10491048
Of the parsed name's own views, ``capitalized()`` is the only one
10501049
handed a vocabulary. (The v1 :class:`~nameparser.parser.HumanName`
1051-
facade's ``initials()`` is handed one too, and likewise asks it whether
1052-
a spliced word is a conjunction; it is not a method of the parsed
1053-
name.)
1050+
facade's ``initials()`` is handed one too, and asks it whether a
1051+
spliced word is a conjunction or a particle, so a spliced ``de la`` gives
1052+
no initials there; it is not a method of the parsed name.)
10541053

10551054
.. doctest::
10561055

0 commit comments

Comments
 (0)