Skip to content

Commit 28078c7

Browse files
derek73claude
andcommitted
docs: name_order links to the Name-order constants reference section
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent b746792 commit 28078c7

2 files changed

Lines changed: 4 additions & 1 deletion

File tree

docs/modules.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@ Configuration
6060
.. autoclass:: nameparser.PatronymicRule
6161
:members:
6262

63+
.. _name-order-constants:
64+
6365
Name-order constants
6466
^^^^^^^^^^^^^^^^^^^^
6567

nameparser/_policy.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,8 @@ class Policy:
6565
-- and pass the result to ``Parser(policy=...)``."""
6666

6767
#: How positional (no-comma) input maps onto given/middle/family.
68-
#: Valid values are exactly the three exported constants --
68+
#: Valid values are exactly the three exported
69+
#: :ref:`name-order constants <name-order-constants>` --
6970
#: GIVEN_FIRST (the default), FAMILY_FIRST, and
7071
#: FAMILY_FIRST_GIVEN_LAST; any other tuple of Roles raises
7172
#: ValueError. Ignored when the input contains a comma:

0 commit comments

Comments
 (0)