Skip to content

Commit f0bd837

Browse files
derek73claude
andcommitted
docs: Role members document the seven fields in the reference
Same enum-member invisibility as AmbiguityKind: without doc comments autodoc skipped them, so the class docstring promised seven fields the page never listed. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent d2cc767 commit f0bd837

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

nameparser/_types.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,21 @@ class Role(Enum):
3333

3434
# Declaration order IS the canonical field order (conventions §3):
3535
# every listing of the seven fields anywhere derives from this.
36+
37+
#: Pre-nominal titles and honorifics ("Dr.", "Sir", "Capt.").
3638
TITLE = "title"
39+
#: The given (first) name, or its initial.
3740
GIVEN = "given"
41+
#: Names between given and family -- middle names or initials.
3842
MIDDLE = "middle"
43+
#: The family (last) name, including any particles ("de la Vega").
3944
FAMILY = "family"
45+
#: Post-nominal pieces ("III", "Jr.", "PhD").
4046
SUFFIX = "suffix"
47+
#: Delimited nickname content ("Jonathan 'Jack' Kennedy" -> "Jack").
4148
NICKNAME = "nickname"
49+
#: A birth surname, from a marker word ("Jane Smith née Jones" ->
50+
#: "Jones") or a delimiter pair routed via Policy.maiden_delimiters.
4251
MAIDEN = "maiden"
4352

4453

0 commit comments

Comments
 (0)