gh-112328: Document EnumDict in docs and release notes (GH-121720)

Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
This commit is contained in:
Md Rokibul Islam 2024-12-20 00:38:42 +01:00 committed by GitHub
parent c14db20275
commit 39e69a7cd5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 21 additions and 1 deletions

View File

@ -149,9 +149,14 @@ Module Contents
Return a list of all power-of-two integers contained in a flag. Return a list of all power-of-two integers contained in a flag.
:class:`EnumDict`
A subclass of :class:`dict` for use when subclassing :class:`EnumType`.
.. versionadded:: 3.6 ``Flag``, ``IntFlag``, ``auto`` .. versionadded:: 3.6 ``Flag``, ``IntFlag``, ``auto``
.. versionadded:: 3.11 ``StrEnum``, ``EnumCheck``, ``ReprEnum``, ``FlagBoundary``, ``property``, ``member``, ``nonmember``, ``global_enum``, ``show_flag_values`` .. versionadded:: 3.11 ``StrEnum``, ``EnumCheck``, ``ReprEnum``, ``FlagBoundary``, ``property``, ``member``, ``nonmember``, ``global_enum``, ``show_flag_values``
.. versionadded:: 3.14 ``EnumDict``
--------------- ---------------
@ -821,7 +826,17 @@ Data Types
>>> KeepFlag(2**2 + 2**4) >>> KeepFlag(2**2 + 2**4)
<KeepFlag.BLUE|16: 20> <KeepFlag.BLUE|16: 20>
.. versionadded:: 3.11 .. versionadded:: 3.11
.. class:: EnumDict
*EnumDict* is a subclass of :class:`dict` for use when subclassing :class:`EnumType`.
.. attribute:: EnumDict.member_names
Return list of member names.
.. versionadded:: 3.14
--------------- ---------------

View File

@ -879,6 +879,11 @@ email
(Contributed by Thomas Dwyer and Victor Stinner for :gh:`102988` to improve (Contributed by Thomas Dwyer and Victor Stinner for :gh:`102988` to improve
the :cve:`2023-27043` fix.) the :cve:`2023-27043` fix.)
enum
----
* :class:`~enum.EnumDict` has been made public in :mod:`enum` to better support
subclassing :class:`~enum.EnumType`.
fractions fractions
--------- ---------