Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2026-01-07 16:02:55 +00:00
Code Issues Projects Releases Packages Wiki Activity

gh-101739: [Enum] update docs - default boundary for Flag is CONFORM (GH-101746)

Browse source 
(cherry picked from commit 7f1c721756)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
This commit is contained in:
Miss Islington (bot) 2023-02-17 13:44:45 -08:00 • committed by GitHub
parent be69ac3c96
commit b7a49eb5ff
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

17
Doc/library/enum.rst
View 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()