sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-10-15 00:02:52 -04:00
Code Issues Packages Projects Releases Wiki Activity

Avoid None as value for referenced_columns (use empty list instead) in qgsfunction.py documentation

Browse Source
This commit is contained in:
Germán Carrillo 2023-11-02 16:31:45 +01:00
parent 0ec6a190cf
commit ac80a3782e
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
python/core/additions/qgsfunction.py
View File

@ -118,7 +118,7 @@ def register_function(
:param args: DEPRECATED since QGIS 3.32. Use ``params_as_list`` if you want to pass parameters as a list. :param args: DEPRECATED since QGIS 3.32. Use ``params_as_list`` if you want to pass parameters as a list.
:param group: the expression group in which the function should be added :param group: the expression group in which the function should be added
:param usesgeometry: Defines if this expression requires the geometry. By default False. :param usesgeometry: Defines if this expression requires the geometry. By default False.
:param referenced_columns: An array of field names on which this expression works. By default ``[QgsFeatureRequest.ALL_ATTRIBUTES]``. Can be set to None for slightly faster evaluation. :param referenced_columns: An array of field names on which this expression works. By default ``[QgsFeatureRequest.ALL_ATTRIBUTES]``. Can be set to an empty list for slightly faster evaluation.
:param handlesnull: Defines if this expression has custom handling for NULL values. If False, the result will always be NULL as soon as any parameter is NULL. False by default. :param handlesnull: Defines if this expression has custom handling for NULL values. If False, the result will always be NULL as soon as any parameter is NULL. False by default.
:param params_as_list: If True, the function will receive the expression parameters as a list. If False, the function will receive the parameters as individual arguments. False by default. :param params_as_list: If True, the function will receive the expression parameters as a list. If False, the function will receive the parameters as individual arguments. False by default.
@ -185,7 +185,7 @@ def qgsfunction(args="auto", group="custom", **kwargs):
* *usesgeometry* (``bool``) -- * *usesgeometry* (``bool``) --
Defines if this expression requires the geometry. By default False. Defines if this expression requires the geometry. By default False.
* *referenced_columns* (``list``) -- * *referenced_columns* (``list``) --
An array of field names on which this expression works. By default ``[QgsFeatureRequest.ALL_ATTRIBUTES]``. Can be set to None for slightly faster evaluation. An array of field names on which this expression works. By default ``[QgsFeatureRequest.ALL_ATTRIBUTES]``. Can be set to an empty list for slightly faster evaluation.
* *handlesnull* (``bool``) -- * *handlesnull* (``bool``) --
Defines if this expression has custom handling for NULL values. If False, the result will always be NULL as soon as any parameter is NULL. False by default. Defines if this expression has custom handling for NULL values. If False, the result will always be NULL as soon as any parameter is NULL. False by default.
* *params_as_list* (``bool``) \since QGIS 3.32 -- * *params_as_list* (``bool``) \since QGIS 3.32 --