aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/considerations.rst
diff options
context:
space:
mode:
authorCristián Maureira-Fredes <Cristian.Maureira-Fredes@qt.io>2023-04-04 17:19:23 +0200
committerCristián Maureira-Fredes <Cristian.Maureira-Fredes@qt.io>2023-04-05 09:26:43 +0200
commit900c050c66119454585ec83cf31149f6d64dd3ea (patch)
treec9db45471d33aaf9ca6ad7de191d73eed2cbec24 /sources/pyside6/doc/considerations.rst
parentd35b650fe4369952a44c3891fedb6d8ee1417df5 (diff)
doc: fix issues with pyside rst files
Fixing extra indentation, syntax issues, and formatting. Adapting too some snippet line highlights, and many other details. Pick-to: 6.5 Change-Id: Ife4eb5cec03577b2902d409b4007ae6d12141747 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Diffstat (limited to 'sources/pyside6/doc/considerations.rst')
-rw-r--r--sources/pyside6/doc/considerations.rst18
1 files changed, 7 insertions, 11 deletions
diff --git a/sources/pyside6/doc/considerations.rst b/sources/pyside6/doc/considerations.rst
index 680d70340..58c95a112 100644
--- a/sources/pyside6/doc/considerations.rst
+++ b/sources/pyside6/doc/considerations.rst
@@ -254,7 +254,7 @@ Activating the New Enums
The new approach to enum will be the default in ``PySide 6.4``, but a preview is already built
into ``PySide 6.3`` with the environment variable:
-`PYSIDE63_OPTION_PYTHON_ENUM=1 python3 <myscript>` enables the new enums.
+``PYSIDE63_OPTION_PYTHON_ENUM=1 python3 <myscript>`` enables the new enums.
In ``PySide 6.4``, this flag is by default on, but it can be switched to the old Shiboken
enums by setting the variable to 0.
@@ -268,13 +268,10 @@ The Differences between old and new Enums
Python enums and Shiboken enums are more or less compatible with each other.
Tiny differences are in restrictions:
- * Python enums cannot inherit from each other, whereas Shiboken enums can
-
- * Python enums don't allow undefined values, Shiboken enums do
-
- * Python enums always need exactly one argument, Shiboken enums have a default zero value
-
- * Python enums rarely inherit from int, Shiboken enums always do
+* Python enums cannot inherit from each other, whereas Shiboken enums can
+* Python enums don't allow undefined values, Shiboken enums do
+* Python enums always need exactly one argument, Shiboken enums have a default zero value
+* Python enums rarely inherit from int, Shiboken enums always do
More visible are the differences between flags, as shown in the following:
@@ -348,9 +345,8 @@ and never propose the old ones.
The reason to implement ``forgiveness mode`` this way was
- * to make the transition as smooth as possible, but
-
- * to encourage people to use the new enums whenever new code is written.
+* to make the transition as smooth as possible, but
+* to encourage people to use the new enums whenever new code is written.
So you can continue to write: