diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2025-01-29 22:35:39 +0100 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2025-02-03 18:13:05 +0100 |
| commit | a5ecb36c75723b9e82de13d712db9060ed6a3753 (patch) | |
| tree | a280deee7b71fc0fd9e1c89e33b35915c228bc1f | |
| parent | ecc05e2c3ddd821eb02d3b0bc70fb3e2eced1372 (diff) | |
Documentation: Various fixes
- Fix spelling and a misplaced anchor
- Add note about enumerations
Pick-to: 6.8
Change-Id: Iafb8eaff6140381aeaa705c0d164b72708a00154
Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
| -rw-r--r-- | sources/pyside6/doc/developer/add_port_example.rst | 1 | ||||
| -rw-r--r-- | sources/shiboken6/doc/index.rst | 2 | ||||
| -rw-r--r-- | sources/shiboken6/doc/typesystem_specifying_types.rst | 4 |
3 files changed, 4 insertions, 3 deletions
diff --git a/sources/pyside6/doc/developer/add_port_example.rst b/sources/pyside6/doc/developer/add_port_example.rst index 18f826bc3..59aa2f115 100644 --- a/sources/pyside6/doc/developer/add_port_example.rst +++ b/sources/pyside6/doc/developer/add_port_example.rst @@ -60,6 +60,7 @@ Port a Qt example ``snippets-translate``). - Note that our examples need to have unique names due to the doc build. - Verify that all slots are decorated using ``@Slot``. +- Enumerations should be fully qualified (PYSIDE-1735). - Add a ``.pyproject`` file (verify later on that docs build). - Add a ``doc`` directory and descriptive ``.rst`` file, and a screenshot if suitable (use ``optipng`` to reduce file size). diff --git a/sources/shiboken6/doc/index.rst b/sources/shiboken6/doc/index.rst index 68f96dded..de031b96b 100644 --- a/sources/shiboken6/doc/index.rst +++ b/sources/shiboken6/doc/index.rst @@ -67,7 +67,7 @@ Documentation .. grid-item-card:: :class-item: text-center - Reference and functionallities. + Reference and functionality. +++ .. button-ref:: typesystem :color: primary diff --git a/sources/shiboken6/doc/typesystem_specifying_types.rst b/sources/shiboken6/doc/typesystem_specifying_types.rst index ab085df8d..300b04e2f 100644 --- a/sources/shiboken6/doc/typesystem_specifying_types.rst +++ b/sources/shiboken6/doc/typesystem_specifying_types.rst @@ -889,8 +889,6 @@ for enclosing added functions referring to those classes within Other keywords can be specified using the :ref:`--keywords <conditional_keywords>` command line option. -.. _private_types: - Defining Entities ^^^^^^^^^^^^^^^^^ @@ -904,6 +902,8 @@ It is possible to define entities using a simple processing instruction: This allows for defining function signatures depending on platform in conjunction with :ref:`conditional_processing`. +.. _private_types: + Private Types ^^^^^^^^^^^^^ |