Commit 76e85dc
docs: introduce and properly describe the module-level constants
autodata on a re-export can't see the defining module's #: doc
comments, so every module-level constant rendered its TYPE's
docstring -- GIVEN_FIRST et al. showed tuple's 'Built-in immutable
sequence', DEFAULT_NICKNAME_DELIMITERS showed frozenset's constructor
help, UNSET rendered blank. Replace them with manual py:data
directives carrying real descriptions, under two new reference
sub-headings ('Name-order constants' -- stating that name_order
accepts ONLY these three, arbitrary Role tuples raise -- and
'Delimiter defaults'). The customize table's name_order type cell now
says 'one of the three exported order constants' instead of the
tuple[Role, Role, Role] annotation that invited hand-rolled tuples.
The #: comments stay in _policy.py for source readers.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>1 parent f609d40 commit 76e85dc
3 files changed
Lines changed: 52 additions & 6 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
61 | 61 | | |
62 | 62 | | |
63 | 63 | | |
64 | | - | |
| 64 | + | |
65 | 65 | | |
66 | 66 | | |
67 | 67 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
47 | 47 | | |
48 | 48 | | |
49 | 49 | | |
50 | | - | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
51 | 55 | | |
52 | 56 | | |
53 | 57 | | |
54 | 58 | | |
55 | | - | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
56 | 85 | | |
57 | | - | |
| 86 | + | |
| 87 | + | |
58 | 88 | | |
59 | | - | |
| 89 | + | |
| 90 | + | |
60 | 91 | | |
61 | | - | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
62 | 98 | | |
63 | 99 | | |
64 | 100 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
24 | 28 | | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
25 | 32 | | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
26 | 36 | | |
27 | 37 | | |
28 | 38 | | |
| |||
0 commit comments