Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions docs/documentation_guidelines/writing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -642,6 +642,19 @@ guidelines:

To find out the algorithm name you can just hover the mouse on the algorithm in
the Processing toolbox.
* Mention the QGIS version in which the algorithm was introduced:

.. code-block:: rst

``Added in 3.44``

Likewise, mention if the algorithm requires a specific optional dependency (and version).

.. code-block:: rst

.. attention:: Running this algorithm requires QGIS installed with <library> >= min_value
(see :menuselection:`Help --> About` menu).

* Avoid using "This algorithm does this and that..." as the first sentence in the
algorithm description. Try to use more general expressions like:

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

.. code-block:: rst
Expand All @@ -681,6 +693,9 @@ guidelines:
Default: 1
- Number of points to create

* When a parameter or a parameter's value is added to an already existing algorithm,
indicate the QGIS version in which it is introduced.
If it requires a specific library, also indicate its minimal requirements.
* Describe the *type* of input supported the parameters. There are several types
available you can pick one from:

Expand Down
11 changes: 1 addition & 10 deletions docs/user_manual/processing_algs/gdal/miscellaneous.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Miscellaneous

Dataset Identification
----------------------
|400|
``Added in 4.0``

Reports the name of GDAL drivers that can open files contained in a folder,
with optional additional details, and write the result into an output vector layer.
Expand Down Expand Up @@ -106,12 +106,3 @@ Python code
.. include:: ../algs_include.rst
:start-after: **algorithm_code_section**
:end-before: **end_algorithm_code_section**


.. Substitutions definitions - AVOID EDITING PAST THIS LINE
This will be automatically updated by the find_set_subst.py script.
If you need to create a new substitution manually,
please add it also to the substitutions.txt file in the
source folder.

.. |400| replace:: ``NEW in 4.0``
1 change: 1 addition & 0 deletions docs/user_manual/processing_algs/gdal/rasterconversion.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Raster conversion

Create Cloud Optimized GeoTIFF
-------------------------------
``Added in 4.0``

Creates a Cloud Optimized GeoTIFF (COG) from the input raster layers.

Expand Down
2 changes: 2 additions & 0 deletions docs/user_manual/processing_algs/gdal/rastermiscellaneous.rst
Original file line number Diff line number Diff line change
Expand Up @@ -919,6 +919,8 @@ Basic parameters
Default: Not set
- Value to use for NoData
* - **Handling of extent differences**

``Added in 3.34``
- ``EXTENT_OPT``
- [enumeration]

Expand Down
5 changes: 5 additions & 0 deletions docs/user_manual/processing_algs/gdal/vectormiscellaneous.rst
Original file line number Diff line number Diff line change
Expand Up @@ -875,6 +875,8 @@ Basic parameters
- [vector: geometry]
- Input vector layer
* - **Enable listing of all layers in the dataset**

``Added in 3.40``
- ``ALL_LAYERS``
- [boolean]

Expand Down Expand Up @@ -913,6 +915,7 @@ Basic parameters

Advanced parameters
^^^^^^^^^^^^^^^^^^^
``Added in 3.40``

.. list-table::
:header-rows: 1
Expand Down Expand Up @@ -963,6 +966,8 @@ Python code

Vector Information (JSON)
-------------------------
``Added in 3.40``

Creates an information file that lists information about an
OGR-supported data source.
The output will be shown in a 'Result' window and can be written
Expand Down
2 changes: 2 additions & 0 deletions docs/user_manual/processing_algs/qgis/3dtiles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

Convert B3DM to GLTF
--------------------
``Added in 3.34``

Converts files from the legacy :file:`.B3DM` format to :file:`.GLTF` or :file:`.GLB`.

Expand Down Expand Up @@ -73,6 +74,7 @@ Python code

Convert GLTF to vector features
-------------------------------
``Added in 3.34``

Converts :file:`.GLTF` or :file:`.GLB` file contents to standard vector layer formats.

Expand Down
6 changes: 3 additions & 3 deletions docs/user_manual/processing_algs/qgis/cartography.rst
Original file line number Diff line number Diff line change
Expand Up @@ -704,7 +704,7 @@ Advanced parameters

* 0 - Always export text as paths (recommended)
* 1 - Always export texts as text objects
* 2 - Prefer exporting texts as text objects
* 2 - Prefer exporting texts as text objects --- ``Added in 3.40``
* - **Image compression**
- ``IMAGE_COMPRESSION``
- [enumeration]
Expand Down Expand Up @@ -880,7 +880,7 @@ Advanced parameters

* 0 - Always export text as paths (recommended)
* 1 - Always export texts as text objects
* 2 - Prefer exporting texts as text objects
* 2 - Prefer exporting texts as text objects --- ``Added in 3.40``
* - **Image compression**
- ``IMAGE_COMPRESSION``
- [enumeration]
Expand Down Expand Up @@ -1137,7 +1137,7 @@ Advanced parameters

* 0 - Always export text as paths (recommended)
* 1 - Always export texts as text objects
* 2 - Prefer exporting texts as text objects
* 2 - Prefer exporting texts as text objects --- ``Added in 3.40``
* - **Image compression**
- ``IMAGE_COMPRESSION``
- [enumeration]
Expand Down
21 changes: 20 additions & 1 deletion docs/user_manual/processing_algs/qgis/checkgeometry.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Check Geometry

Dangle-end lines
----------------
``Added in 3.42``

Detects dangle-end lines in line geometries and reports them as errors.
A dangle-end line is a line feature that terminates at a vertex connected to only one segment,
Expand Down Expand Up @@ -142,6 +143,7 @@ Python code

Degenerate polygons
-------------------
``Added in 3.42``

Checks the polygons with less than 3 points, which are degenerate polygons.
Degenerate polygons are errors.
Expand Down Expand Up @@ -270,6 +272,7 @@ Python code

Duplicated geometries
---------------------
``Added in 3.42``

Checks for duplicated geometries in a vector layer, and reports them as errors.

Expand Down Expand Up @@ -391,6 +394,7 @@ Python code

Duplicated vertices
-------------------
``Added in 3.42``

Checks for duplicated vertices in line or polygon geometries,
and reports them as errors.
Expand Down Expand Up @@ -514,6 +518,7 @@ Python code

Features inside polygon
-----------------------
``Added in 3.42``

Checks the input geometries contained in the polygons from the polygon layers list.
A polygon layer can be checked against itself.
Expand Down Expand Up @@ -646,6 +651,7 @@ Python code

Holes
------------
``Added in 3.42``

Detects holes in polygon geometries and reports them as errors.

Expand Down Expand Up @@ -773,6 +779,7 @@ Python code

Lines intersecting each other
-----------------------------
``Added in 3.42``

Checks intersections between line geometries within a layer.
Intersections between two different lines are errors.
Expand Down Expand Up @@ -897,6 +904,7 @@ Python code

Lines intersecting other layer
------------------------------
``Added in 3.42``

Checks if the input line layer features intersect with the check layer features.
An input feature that intersects with a check layer feature is an error.
Expand Down Expand Up @@ -1024,6 +1032,7 @@ Python code

Missing vertices along borders
------------------------------
``Added in 3.42``

Checks for missing vertices along polygon borders.
To be topologically correct, a vertex at the junction of two polygons
Expand Down Expand Up @@ -1154,6 +1163,7 @@ Python code

Overlaps
------------------
``Added in 3.42``

Calculates overlapping areas in polygon geometries, and reports areas smaller than a given minimum as errors.

Expand Down Expand Up @@ -1282,6 +1292,7 @@ Python code

Points outside lines
--------------------
``Added in 3.42``

Checks if the points in the input layer are covered by a line in the selected line layers.
A point not covered by a line is an error.
Expand Down Expand Up @@ -1393,6 +1404,7 @@ Python code

Points outside polygons
-----------------------
``Added in 3.42``

Checks if points from the input layer are in polygons from the selected polygon layers.
Points that are not fully inside polygons are errors.
Expand Down Expand Up @@ -1504,6 +1516,7 @@ Python code

Self-contacts
------------------
``Added in 3.42``

Checks if the geometry has self contact points (in line or polygon),
i.e., a vertex that touches more than two segments of the same ring.
Expand Down Expand Up @@ -1640,6 +1653,7 @@ Python code

Self-intersections
------------------
``Added in 3.42``

Detects self-intersections in line or polygon geometries, and reports them as errors.
Self-intersections occur when the segments of a geometry cross over each other
Expand Down Expand Up @@ -1777,6 +1791,7 @@ Python code

Sliver polygons
------------------
``Added in 3.42``

Detects sliver polygons in a polygon layer,
i.e., polygons with a thinness greater than a specified value.
Expand Down Expand Up @@ -1934,6 +1949,7 @@ Python code

Small angles
------------
``Added in 3.42``

Compares the angles within line or polygon geometries to a specified threshold,
and reports as error any angle below that value.
Expand Down Expand Up @@ -2047,6 +2063,7 @@ Python code

Small polygons
------------------
``Added in 3.42``

Detects polygon features whose area is below a specified value as errors.

Expand Down Expand Up @@ -2188,6 +2205,7 @@ Python code

Small gaps
---------------------
``Added in 3.42``

Checks for gaps between polygons in the input layer.
Gaps with an area smaller than the gap threshold are reported as errors.
Expand Down Expand Up @@ -2361,6 +2379,7 @@ Python code

Small segments
---------------------
``Added in 3.42``

Calculates length of individual segments in line or polygon geometries,
and reports segments shorter than a minimum length as errors.
Expand Down Expand Up @@ -2496,6 +2515,7 @@ Python code

Strictly multipart
---------------------
``Added in 3.42``

Checks if multipart geometries have more than one part.
Multipart geometries with only one part are errors.
Expand Down Expand Up @@ -2615,7 +2635,6 @@ Python code
:end-before: **end_algorithm_code_section**



.. Substitutions definitions - AVOID EDITING PAST THIS LINE
This will be automatically updated by the find_set_subst.py script.
If you need to create a new substitution manually,
Expand Down
2 changes: 2 additions & 0 deletions docs/user_manual/processing_algs/qgis/filetools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,8 @@ Python code

HTTP(S) POST/GET request
------------------------
``Added in 3.40``

Performs a HTTP(S) POST/GET request and returns the HTTP status code and the reply data.
If an error occurs then the error code and the message will be returned.
Optionally, the result can be written to a file on the disk.
Expand Down
Loading
Loading