Skip to content

Commit 5f1f6ac

Browse files
derek73claude
andcommitted
docs: name the subject in the configuration heading
"Three containers, three concerns" never said what was in three containers, so a reader scanning the page could not tell the section was about configuration. The chime is memorable once you have read it and invisible before that. "Configuration lives in three containers" adds the subject, keeps the compact subject-verb shape of its neighbor "Two layers decide the roles", and echoes the section's own opening sentence. Deliberately not converting concepts.rst headings to the task-shaped style used in customize.rst -- one page explains, the other is looked things up in. Also fixes the page intro, which still enumerated four ideas and promised "these four ideas". Adding the two-layer section earlier today made it five; the enumeration never mentioned how tokens get their roles. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 261c9c9 commit 5f1f6ac

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

docs/concepts.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@ How the parser works
33

44
``parse()`` turns a name string into a
55
:class:`~nameparser.ParsedName`. This page explains the model behind
6-
that call: how a string becomes tokens and tokens become fields,
7-
where configuration lives and why it is split the way it is, why
8-
parsers are plain values, and what happens when a name is genuinely
9-
ambiguous. The task pages all build on these four ideas.
6+
that call: how a string becomes tokens and tokens become fields, how
7+
those tokens get their roles, where configuration lives and why it is
8+
split the way it is, why parsers are plain values, and what happens
9+
when a name is genuinely ambiguous. The task pages all build on these
10+
five ideas.
1011

1112
From string to name
1213
--------------------
@@ -71,8 +72,8 @@ you look anything up: if you are teaching the parser a *word*, it goes
7172
in the :class:`~nameparser.Lexicon`; if you are changing how unclaimed
7273
words are *arranged*, it goes in the :class:`~nameparser.Policy`.
7374

74-
Three containers, three concerns
75-
--------------------------------
75+
Configuration lives in three containers
76+
----------------------------------------
7677

7778
Every piece of nameparser configuration falls into exactly one of
7879
three places, and which one is decided by a single question: what does

0 commit comments

Comments
 (0)