aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2021-11-16 08:36:42 +0100
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2021-11-16 09:58:23 +0000
commitb97d977a5def85f262ac6f82c9f246e81816f4e1 (patch)
tree91afef44cfd9ede61da65a051066390d1ac5292b
parent52cc0e6bc01f91f61a270c984690dd073f2cb12f (diff)
PySide6: Fix documentation for QmlUncreatable
Add a blank line for code-block to work and fix the indentation. Amends a421aab61ad03afa595aa0ba7e53d84b1edbe892. Task-number: PYSIDE-1709 Change-Id: Idecb8a69b510191ab1ea27754d71eb94b2f6394a Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit 3c17a00f5494dbbe87d7628d4a38e34560808fc0) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--sources/pyside6/doc/extras/QtQml.QmlUncreatable.rst17
1 files changed, 9 insertions, 8 deletions
diff --git a/sources/pyside6/doc/extras/QtQml.QmlUncreatable.rst b/sources/pyside6/doc/extras/QtQml.QmlUncreatable.rst
index ef6803cee..72fde741d 100644
--- a/sources/pyside6/doc/extras/QtQml.QmlUncreatable.rst
+++ b/sources/pyside6/doc/extras/QtQml.QmlUncreatable.rst
@@ -17,14 +17,15 @@ Some QML types are implicitly uncreatable, in particular types exposed with
Passing None or no argument will cause a standard message to be used instead.
.. code-block:: python
- QML_IMPORT_NAME = "com.library.name"
- QML_IMPORT_MAJOR_VERSION = 1
- QML_IMPORT_MINOR_VERSION = 0 # Optional
+ QML_IMPORT_NAME = "com.library.name"
+ QML_IMPORT_MAJOR_VERSION = 1
+ QML_IMPORT_MINOR_VERSION = 0 # Optional
- @QmlElement
- @QmlUncreatable("BaseClassForQml is an abstract base class")
- class BaseClassForQml(QObject):
- # ...
-.. note:: The order of the decorators matters, ``QmlUncreatable`` needs to be preceded by ``QmlElement``.
+ @QmlElement
+ @QmlUncreatable("BaseClassForQml is an abstract base class")
+ class BaseClassForQml(QObject):
+ # ...
+
+.. note:: The order of the decorators matters; ``QmlUncreatable`` needs to be preceded by ``QmlElement``.