aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2024-01-25 09:24:14 +0100
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2024-01-25 18:35:29 +0000
commitae0be3ae4e049efb4b9a32d98d3f4520f7e7dd61 (patch)
treeed1d4a19debfbf92b87d1877b98bebb249c06cec
parent6d50ff0a89dd1cb26c4d4af8a3b50a9cd50ad9ef (diff)
Document the lesser known aspects of adding modules/examples
Change-Id: Id3b7a411222808d7b783220dd6f383ad0de309dc Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit 1414bfa6df945075fc0c385e885b65dff4ffa053) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--sources/pyside6/doc/developer/add_module.rst9
-rw-r--r--sources/pyside6/doc/developer/add_port_example.rst11
2 files changed, 16 insertions, 4 deletions
diff --git a/sources/pyside6/doc/developer/add_module.rst b/sources/pyside6/doc/developer/add_module.rst
index 321a34723..f75aa5489 100644
--- a/sources/pyside6/doc/developer/add_module.rst
+++ b/sources/pyside6/doc/developer/add_module.rst
@@ -44,6 +44,15 @@ Add bindings
of using ``#include <QtModule/header.h>`` since module include paths
are not passed in PySide.
+Distribution
+------------
+
+- Determine to which wheel the module belongs according to
+ `Qt Modules <https://doc.qt.io/qt-6/qtmodules.html>`_.
+- Add the module to ``build_scripts/wheel_files.py`` for use by
+ ``create_wheels.py``.
+- Add the module to one of the ``README.pyside6_*.md`` files.
+
Add documentation
-----------------
diff --git a/sources/pyside6/doc/developer/add_port_example.rst b/sources/pyside6/doc/developer/add_port_example.rst
index fdb400ec9..b99641f45 100644
--- a/sources/pyside6/doc/developer/add_port_example.rst
+++ b/sources/pyside6/doc/developer/add_port_example.rst
@@ -10,10 +10,13 @@ You can either design an example from scratch or inspired in another
application, or simply you can port an existing Qt example that does not have
a Python counterpart.
-For both cases, we recommend you to use tools like
-`flake8 <https://pypi.org/project/flake8/>`_
-(or `ruff <https://pypi.org/project/ruff/>`_) to detect issues with your code.
+Example code should be free of `flake8 <https://pypi.org/project/flake8/>`_
+warnings; this is enforced by a bot. A configuration file is provided
+at the root of the repository. Offending lines can be excluded by a
+``noqa`` directive if there is a good reason to do so.
+
Keep in mind we do allow 100 columns for line length.
+
Additionally, please use `isort <https://pypi.org/project/isort/>`_ to keep the
imports ordered and consistent with other examples.
@@ -21,7 +24,7 @@ For example:
.. code-block:: bash
- $ flake8 --ignore=E266 your_file.py
+ $ flake8 --config pyside-setup/.flake8 your_file.py
$ isort your_file.py