From: chrysn Date: Tue, 7 May 2024 18:11:18 +0000 (+0200) Subject: gh-118650: Document `Enum._repr_*` reservation exclusion (GH-118698) X-Git-Tag: v3.13.0b1~10 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f58833ebf8161aaa33844d63fb51b1575180cfbb;p=thirdparty%2FPython%2Fcpython.git gh-118650: Document `Enum._repr_*` reservation exclusion (GH-118698) --- diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst index 6837b45894b3..21f41b73086c 100644 --- a/Doc/library/enum.rst +++ b/Doc/library/enum.rst @@ -861,9 +861,15 @@ Supported ``_sunder_`` names For :class:`Flag` classes the next value chosen will be the next highest power-of-two. +- While ``_sunder_`` names are generally reserved for the further development + of the :class:`Enum` class and can not be used, some are explicitly allowed: + + - ``_repr_*`` (e.g. ``_repr_html_``), as used in `IPython's rich display`_ + .. versionadded:: 3.6 ``_missing_``, ``_order_``, ``_generate_next_value_`` .. versionadded:: 3.7 ``_ignore_`` -.. versionadded:: 3.13 ``_add_alias_``, ``_add_value_alias_`` +.. versionadded:: 3.13 ``_add_alias_``, ``_add_value_alias_``, ``_repr_*`` +.. _`IPython's rich display`: https://ipython.readthedocs.io/en/stable/config/integrating.html#rich-display ---------------