aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/developer
diff options
context:
space:
mode:
authorChristian Tismer <[email protected]>2023-06-09 13:48:44 +0200
committerChristian Tismer <[email protected]>2023-06-16 19:15:31 +0200
commit9446e0c8b4711cb886c2449fd8e17dcb26e69b6b (patch)
tree85b6e694870f1dd08fd2d84ec781fdb5190118cb /sources/pyside6/doc/developer
parent2b75519adf23ba490e32659ca337b48e7ae4ec41 (diff)
PyEnum: Update docs and rename the option
The new Enum implementation can no longer be switched off. Individual features can still be deselected with the environment variable PYSIDE6_OPTION_PYTHON_ENUM which had the name PYSIDE63_OPTION_PYTHON_ENUM before. This change is meant for PySide 6.6 . Task-number: PYSIDE-1735 Change-Id: Iae5b7a9d42a0d7b005dbba20201a80713ef79be9 Reviewed-by: Friedemann Kleint <[email protected]>
Diffstat (limited to 'sources/pyside6/doc/developer')
-rw-r--r--sources/pyside6/doc/developer/enumfeatures_doc.rst8
1 files changed, 5 insertions, 3 deletions
diff --git a/sources/pyside6/doc/developer/enumfeatures_doc.rst b/sources/pyside6/doc/developer/enumfeatures_doc.rst
index b3edbe7b6..91b7b6346 100644
--- a/sources/pyside6/doc/developer/enumfeatures_doc.rst
+++ b/sources/pyside6/doc/developer/enumfeatures_doc.rst
@@ -1,3 +1,5 @@
+.. _enum-features:
+
The Set of Enum Features
========================
@@ -17,7 +19,7 @@ This is the table of all flags used to control the creation of Python enums.
====================== ===== ======================================================
Flag Name Value
====================== ===== ======================================================
-ENOPT_OLD_ENUM 0x00 (False) Disable new enums
+ENOPT_OLD_ENUM 0x00 (False) No longer possible since PySide 6.6
ENOPT_NEW_ENUM 0x01 (True) The default for PySide 6.4, full implementation
ENOPT_INHERIT_INT 0x02 Turn all Enum into IntEnum and Flag into IntFlag
ENOPT_GLOBAL_SHORTCUT 0x04 Re-add shortcuts for global enums
@@ -29,8 +31,8 @@ ENOPT_NO_MISSING 0x80 Don't allow missing values in Enum
====================== ===== ======================================================
Such a set of flags can be defined either by the environment variable
-``PYSIDE63_OPTION_PYTHON_ENUM`` or set by the Python variable
-``sys.pyside63_option_python_enum`` before PySide6 is imported.
+``PYSIDE6_OPTION_PYTHON_ENUM`` or set by the Python variable
+``sys.pyside6_option_python_enum`` before PySide6 is imported.
The environment variable also supports arbitrary integer expressions
by using ``ast.literal_eval``.