]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-101739: [Enum] update docs - default boundary for Flag is CONFORM (GH-101746)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 17 Feb 2023 21:44:45 +0000 (13:44 -0800)
committerGitHub <noreply@github.com>
Fri, 17 Feb 2023 21:44:45 +0000 (13:44 -0800)
(cherry picked from commit 7f1c72175600b21c1c840e8988cc6e6b4b244582)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
Doc/library/enum.rst

index 1973578e788c6e6046a59fc6ff1444feb6306732..1803999382080db72a0f792a610f75e484ffb346 100644 (file)
@@ -692,10 +692,9 @@ Data Types
 
    .. attribute:: STRICT
 
-      Out-of-range values cause a :exc:`ValueError` to be raised.  This is the
-      default for :class:`Flag`::
+      Out-of-range values cause a :exc:`ValueError` to be raised::
 
-         >>> from enum import Flag, STRICT
+         >>> from enum import Flag, STRICT, auto
          >>> class StrictFlag(Flag, boundary=STRICT):
          ...     RED = auto()
          ...     GREEN = auto()
@@ -710,9 +709,9 @@ Data Types
    .. attribute:: CONFORM
 
       Out-of-range values have invalid values removed, leaving a valid *Flag*
-      value::
+      value. This is the default for :class:`Flag`::
 
-         >>> from enum import Flag, CONFORM
+         >>> from enum import Flag, CONFORM, auto
          >>> class ConformFlag(Flag, boundary=CONFORM):
          ...     RED = auto()
          ...     GREEN = auto()
@@ -725,7 +724,7 @@ Data Types
       Out-of-range values lose their *Flag* membership and revert to :class:`int`.
       This is the default for :class:`IntFlag`::
 
-         >>> from enum import Flag, EJECT
+         >>> from enum import Flag, EJECT, auto
          >>> class EjectFlag(Flag, boundary=EJECT):
          ...     RED = auto()
          ...     GREEN = auto()
@@ -735,10 +734,10 @@ Data Types
 
    .. attribute:: KEEP
 
-      Out-of-range values are kept, and the *Flag* membership is kept.  This is
-      used for some stdlib flags:
+      Out-of-range values are kept, and the *Flag* membership is kept. This is
+      used for some stdlib flags::
 
-         >>> from enum import Flag, KEEP
+         >>> from enum import Flag, KEEP, auto
          >>> class KeepFlag(Flag, boundary=KEEP):
          ...     RED = auto()
          ...     GREEN = auto()