Skip to content

Commit

Permalink
Raise up sub-type as a parameter, putting more focus on it
Browse files Browse the repository at this point in the history
  • Loading branch information
DelazJ authored and github-actions[bot] committed Dec 21, 2024
1 parent 6112212 commit fbb555b
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 9 deletions.
20 changes: 17 additions & 3 deletions docs/user_manual/processing_algs/algs_include.rst
Original file line number Diff line number Diff line change
Expand Up @@ -349,9 +349,9 @@ Vector field types
* 2 --- Integer (32bit)
* 4 --- Integer (64bit)
* 6 --- Decimal (double)
* 9 --- Integer list --- ``sub_type: 2``
* 9 --- Integer (64bit) list --- ``sub_type: 4``
* 9 --- Decimal (double) list --- ``sub_type: 6``
* 9 --- Integer list
* 9 --- Integer (64bit) list
* 9 --- Decimal (double) list
* 10 --- Text (string)
* 11 --- String list
* 12 --- Binary Object (BLOB)
Expand All @@ -360,3 +360,17 @@ Vector field types
* 16 --- Date & Time

.. **end_vector_field_types**
.. **vector_field_subtypes**
.. The following section is included in vector based algorithms such as
qgisaggregate, qgisrefactorfields
* 2 --- Integer list
* 4 --- Integer (64bit) list
* 6 --- Decimal (double) list
* 10 --- String list
* 0 --- Any other types

.. **end_vector_field_subtypes**
19 changes: 15 additions & 4 deletions docs/user_manual/processing_algs/qgis/vectorgeometry.rst
Original file line number Diff line number Diff line change
Expand Up @@ -326,16 +326,27 @@ Parameters
``Type`` [enumeration] (``type``)
Data type of the output field.
Available types may not be compatible with the output layer provider.
For certain field types, e.g. lists, an extra ``sub_type`` parameter helps refine the
the specific type of the data.
This parameter is automatically set in the GUI but may be needed
if you're running the algorithm in Python or from the command line.
One of:

.. attention:: For certain field types, e.g. lists,
an extra ``sub_type`` parameter helps refine the specific type of the data.
It is automatically set in the GUI but may be needed
if you're running the algorithm in Python or from the command line.

.. include:: ../algs_include.rst
:start-after: **vector_field_types**
:end-before: **end_vector_field_types**

:guilabel:`Sub-type` (``sub_type``) [enumeration]
For certain field types, e.g. lists, this parameter helps refine the specific ``type`` of the data.
It is automatically set in the GUI but may be needed
if you're running the algorithm in Python or from the command line.
One of:

.. include:: ../algs_include.rst
:start-after: **vector_field_subtypes**
:end-before: **end_vector_field_subtypes**

``Length`` [number] (``length``)
Length of the output field.

Expand Down
17 changes: 15 additions & 2 deletions docs/user_manual/processing_algs/qgis/vectortable.rst
Original file line number Diff line number Diff line change
Expand Up @@ -950,14 +950,27 @@ Parameters
:guilabel:`Type` (``type``) [enumeration]
Data type of the output field.
Available types may not be compatible with the output layer provider.
Depending on the field type, an additional ``sub_type`` parameter may be required
when running the algorithm in Python code or command line.
One of:

.. attention:: For certain field types, e.g. lists,
an extra ``sub_type`` parameter helps refine the the specific type of the data.
It is automatically set in the GUI but may be needed
if you're running the algorithm in Python or from the command line.

.. include:: ../algs_include.rst
:start-after: **vector_field_types**
:end-before: **end_vector_field_types**

:guilabel:`Sub-type` (``sub_type``) [enumeration]
For certain field types, e.g. lists, this parameter helps refine the specific ``type`` of the data.
It is automatically set in the GUI but may be needed
if you're running the algorithm in Python or from the command line.
One of:

.. include:: ../algs_include.rst
:start-after: **vector_field_subtypes**
:end-before: **end_vector_field_subtypes**

:guilabel:`Length` (``length``) [number]
Length of the output field.

Expand Down

0 comments on commit fbb555b

Please sign in to comment.