Skip to content

Commit 4531538

Browse files
derek73claude
andcommitted
docs: say when UNSET is actually needed
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 76e85dc commit 4531538

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

docs/modules.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,11 @@ Configuration
5151
5252
Sentinel meaning "this patch does not set this field" — the default
5353
of every :class:`~nameparser.PolicyPatch` field, distinguishable
54-
from every real value including ``None`` and ``False``.
54+
from every real value including ``None`` and ``False``. You rarely
55+
need it: omit a field instead of passing it. Import it to test
56+
whether a patch sets a field (``patch.name_order is UNSET``) or to
57+
leave a field conditionally unset when building patches
58+
programmatically.
5559

5660
.. autoclass:: nameparser.PatronymicRule
5761
:members:

0 commit comments

Comments
 (0)