Skip to content

Commit 371b093

Browse files
derek73claude
andcommitted
docs: cross-link token/span mentions in concepts.rst to API reference
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
1 parent 66a4963 commit 371b093

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

docs/concepts.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ From string to name
1212
--------------------
1313

1414
Every parse follows the same path: the input string is split into
15-
tokens, each token is assigned one of the seven roles — ``title``,
15+
:class:`tokens <nameparser.Token>`, each token is assigned one of the seven roles — ``title``,
1616
``given``, ``middle``, ``family``, ``suffix``, ``nickname``,
1717
``maiden`` — and every string you read off the result is computed
1818
from those tokens at read time.
@@ -23,7 +23,7 @@ and ``Vega`` each carry the ``family`` role, which is why
2323
``name.family`` returns ``"de la Vega"`` — the field is a view that
2424
joins the family-role tokens in order, not a stored string.
2525

26-
Each token also records where it came from. A span is a pair of
26+
Each token also records where it came from. A :class:`~nameparser.Span` is a pair of
2727
character positions bounding the token in the original string:
2828
``Dr.`` has span ``(0, 3)``, and ``name.original[0:3]`` is exactly
2929
``"Dr."``. Internally, spans let the pipeline refer to a token by
@@ -121,7 +121,7 @@ other names, so the parse records a ``particle-or-given`` ambiguity
121121
alongside its answer. You can inspect ``ambiguities`` to decide, case
122122
by case, whether your data needs a second look.
123123

124-
Tokens also carry tags — a second, independent label alongside their
124+
:class:`Tokens <nameparser.Token>` also carry tags — a second, independent label alongside their
125125
role, recording how a token was classified rather than what part of
126126
the name it belongs to — but only a handful of them are part of the
127127
stable API: ``particle``, ``conjunction``, ``initial``, and ``joined``.

0 commit comments

Comments
 (0)