Skip to content

Commit 0eb448c

Browse files
gh-119180: annotationlib: Fix values of Format members in docs (#133841)
gh-119180: Fix values of Format members in docs
1 parent 3396df5 commit 0eb448c

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

Doc/library/annotationlib.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -127,34 +127,34 @@ Classes
127127

128128
Values are the result of evaluating the annotation expressions.
129129

130-
.. attribute:: FORWARDREF
130+
.. attribute:: VALUE_WITH_FAKE_GLOBALS
131131
:value: 2
132132

133+
Special value used to signal that an annotate function is being
134+
evaluated in a special environment with fake globals. When passed this
135+
value, annotate functions should either return the same value as for
136+
the :attr:`Format.VALUE` format, or raise :exc:`NotImplementedError`
137+
to signal that they do not support execution in this environment.
138+
This format is only used internally and should not be passed to
139+
the functions in this module.
140+
141+
.. attribute:: FORWARDREF
142+
:value: 3
143+
133144
Values are real annotation values (as per :attr:`Format.VALUE` format)
134145
for defined values, and :class:`ForwardRef` proxies for undefined
135146
values. Real objects may contain references to :class:`ForwardRef`
136147
proxy objects.
137148

138149
.. attribute:: STRING
139-
:value: 3
150+
:value: 4
140151

141152
Values are the text string of the annotation as it appears in the
142153
source code, up to modifications including, but not restricted to,
143154
whitespace normalizations and constant values optimizations.
144155

145156
The exact values of these strings may change in future versions of Python.
146157

147-
.. attribute:: VALUE_WITH_FAKE_GLOBALS
148-
:value: 4
149-
150-
Special value used to signal that an annotate function is being
151-
evaluated in a special environment with fake globals. When passed this
152-
value, annotate functions should either return the same value as for
153-
the :attr:`Format.VALUE` format, or raise :exc:`NotImplementedError`
154-
to signal that they do not support execution in this environment.
155-
This format is only used internally and should not be passed to
156-
the functions in this module.
157-
158158
.. versionadded:: 3.14
159159

160160
.. class:: ForwardRef

0 commit comments

Comments
 (0)