Skip to content

Commit f5496c4

Browse files
committed
Indicate algorithm versioning matters in writing guidelines
1 parent 41f8c04 commit f5496c4

1 file changed

Lines changed: 17 additions & 2 deletions

File tree

docs/documentation_guidelines/writing.rst

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -642,6 +642,19 @@ guidelines:
642642
643643
To find out the algorithm name you can just hover the mouse on the algorithm in
644644
the Processing toolbox.
645+
* Mention the QGIS version in which the algorithm was introduced:
646+
647+
.. code-block:: rst
648+
649+
``Added in 3.44``
650+
651+
Likewise, mention if the algorithm requires a specific optional dependency (and version).
652+
653+
.. code-block:: rst
654+
655+
.. attention:: Running this algorithm requires QGIS installed with <library> >= min_value
656+
(see :menuselection:`Help --> About` menu).
657+
645658
* Avoid using "This algorithm does this and that..." as the first sentence in the
646659
algorithm description. Try to use more general expressions like:
647660

@@ -668,8 +681,7 @@ guidelines:
668681
* Avoid duplicating detailed description of algorithm options. Add this information
669682
in the parameter description.
670683
* Avoid adding information about the vector geometry type in the algorithm or parameter
671-
description, as this information is already available
672-
in the parameter descriptions.
684+
description, as this information is already available in the parameter descriptions.
673685
* Add the default value of the parameter, e.g.:
674686

675687
.. code-block:: rst
@@ -681,6 +693,9 @@ guidelines:
681693
Default: 1
682694
- Number of points to create
683695
696+
* When a parameter or a parameter's value is added to an already existing algorithm,
697+
indicate the QGIS version in which it is introduced.
698+
If it requires a specific library, also indicate its minimal requirements.
684699
* Describe the *type* of input supported the parameters. There are several types
685700
available you can pick one from:
686701

0 commit comments

Comments
 (0)