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

Fix list formatting for alg docs

Browse Source 
Fixes #42570
This commit is contained in:
Nyall Dawson 2025-04-10 08:18:39 +10:00
parent 54d078ed7a
commit 4de4173841
1 changed files with 65 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

129
python/processing/algfactory.py
View File

@ -436,23 +436,24 @@ class ProcessingAlgFactory:
Apart from `type` this method will take all arguments and pass them though to the correct `QgsProcessingOutputDefinition ` type.
Types:
str: QgsProcessingOutputString
int: QgsProcessingOutputNumber
float: QgsProcessingOutputNumber
alg.NUMBER: QgsProcessingOutputNumber
alg.DISTANCE: QgsProcessingOutputNumber
alg.INT: QgsProcessingOutputNumber
alg.STRING: QgsProcessingOutputString
alg.FILE: QgsProcessingOutputFile
alg.FOLDER: QgsProcessingOutputFolder
alg.HTML: QgsProcessingOutputHtml
alg.LAYERDEF: QgsProcessingOutputLayerDefinition
alg.MAPLAYER: QgsProcessingOutputMapLayer
alg.MULTILAYER: QgsProcessingOutputMultipleLayers
alg.RASTER_LAYER: QgsProcessingOutputRasterLayer
alg.VECTOR_LAYER: QgsProcessingOutputVectorLayer
alg.POINTCLOUD_LAYER: QgsProcessingOutputPointCloudLayer
alg.BOOL: QgsProcessingOutputBoolean
- str: QgsProcessingOutputString
- int: QgsProcessingOutputNumber
- float: QgsProcessingOutputNumber
- alg.NUMBER: QgsProcessingOutputNumber
- alg.DISTANCE: QgsProcessingOutputNumber
- alg.INT: QgsProcessingOutputNumber
- alg.STRING: QgsProcessingOutputString
- alg.FILE: QgsProcessingOutputFile
- alg.FOLDER: QgsProcessingOutputFolder
- alg.HTML: QgsProcessingOutputHtml
- alg.LAYERDEF: QgsProcessingOutputLayerDefinition
- alg.MAPLAYER: QgsProcessingOutputMapLayer
- alg.MULTILAYER: QgsProcessingOutputMultipleLayers
- alg.RASTER_LAYER: QgsProcessingOutputRasterLayer
- alg.VECTOR_LAYER: QgsProcessingOutputVectorLayer
- alg.POINTCLOUD_LAYER: QgsProcessingOutputPointCloudLayer
- alg.BOOL: QgsProcessingOutputBoolean
:param type: The type of the input. This should be a type define on `alg` like alg.STRING, alg.DISTANCE
:keyword label: The label of the output. Will convert into `description` arg.
@ -487,53 +488,53 @@ class ProcessingAlgFactory:
Types:
str: QgsProcessingParameterString
int: QgsProcessingParameterNumber
float: QgsProcessingParameterNumber
bool: QgsProcessingParameterBoolean
alg.NUMBER: QgsProcessingParameterNumber
alg.INT: QgsProcessingParameterNumber
alg.STRING: QgsProcessingParameterString
alg.DISTANCE: QgsProcessingParameterDistance
alg.SINK: QgsProcessingParameterFeatureSink
alg.SOURCE: QgsProcessingParameterFeatureSource
alg.FILE_DEST: QgsProcessingParameterFileDestination
alg.FOLDER_DEST: QgsProcessingParameterFolderDestination
alg.RASTER_LAYER: QgsProcessingParameterRasterLayer
alg.RASTER_LAYER_DEST: QgsProcessingParameterRasterDestination
alg.VECTOR_LAYER_DEST: QgsProcessingParameterVectorDestination
alg.POINTCLOUD_LAYER_DEST: QgsProcessingParameterPointCloudDestination
alg.BAND: QgsProcessingParameterBand
alg.BOOL: QgsProcessingParameterBoolean
alg.CRS: QgsProcessingParameterCrs
alg.ENUM: QgsProcessingParameterEnum
alg.EXPRESSION: QgsProcessingParameterExpression
alg.EXTENT: QgsProcessingParameterExtent
alg.FIELD: QgsProcessingParameterField
alg.FILE: QgsProcessingParameterFile
alg.MAPLAYER: QgsProcessingParameterMapLayer
alg.MATRIX: QgsProcessingParameterMatrix
alg.MULTILAYER: QgsProcessingParameterMultipleLayers
alg.POINT: QgsProcessingParameterPoint
alg.GEOMETRY: QgsProcessingParameterGeometry
alg.RANGE: QgsProcessingParameterRange
alg.VECTOR_LAYER: QgsProcessingParameterVectorLayer
alg.AUTH_CFG: QgsProcessingParameterAuthConfig
alg.MESH_LAYER: QgsProcessingParameterMeshLayer
alg.SCALE: QgsProcessingParameterScale
alg.LAYOUT: QgsProcessingParameterLayout
alg.LAYOUT_ITEM: QgsProcessingParameterLayoutItem
alg.COLOR: QgsProcessingParameterColor
alg.DATETIME: QgsProcessingParameterDateTime(type=QgsProcessingParameterDateTime.Type.DateTime)
alg.DATE: QgsProcessingParameterDateTime(type=QgsProcessingParameterDateTime.Type.Date)
alg.TIME: QgsProcessingParameterDateTime(type=QgsProcessingParameterDateTime.Type.Time)
alg.MAP_THEME: QgsProcessingParameterMapTheme
alg.PROVIDER_CONNECTION: QgsProcessingParameterProviderConnection
alg.DATABASE_SCHEMA: QgsProcessingParameterDatabaseSchema
alg.DATABASE_TABLE: QgsProcessingParameterDatabaseTable
alg.COORDINATE_OPERATION: QgsProcessingParameterCoordinateOperation
alg.POINTCLOUD_LAYER: QgsProcessingParameterPointCloudLayer
alg.ANNOTATION_LAYER: QgsProcessingParameterAnnotationLayer
- str: QgsProcessingParameterString
- int: QgsProcessingParameterNumber
- float: QgsProcessingParameterNumber
- bool: QgsProcessingParameterBoolean
- alg.NUMBER: QgsProcessingParameterNumber
- alg.INT: QgsProcessingParameterNumber
- alg.STRING: QgsProcessingParameterString
- alg.DISTANCE: QgsProcessingParameterDistance
- alg.SINK: QgsProcessingParameterFeatureSink
- alg.SOURCE: QgsProcessingParameterFeatureSource
- alg.FILE_DEST: QgsProcessingParameterFileDestination
- alg.FOLDER_DEST: QgsProcessingParameterFolderDestination
- alg.RASTER_LAYER: QgsProcessingParameterRasterLayer
- alg.RASTER_LAYER_DEST: QgsProcessingParameterRasterDestination
- alg.VECTOR_LAYER_DEST: QgsProcessingParameterVectorDestination
- alg.POINTCLOUD_LAYER_DEST: QgsProcessingParameterPointCloudDestination
- alg.BAND: QgsProcessingParameterBand
- alg.BOOL: QgsProcessingParameterBoolean
- alg.CRS: QgsProcessingParameterCrs
- alg.ENUM: QgsProcessingParameterEnum
- alg.EXPRESSION: QgsProcessingParameterExpression
- alg.EXTENT: QgsProcessingParameterExtent
- alg.FIELD: QgsProcessingParameterField
- alg.FILE: QgsProcessingParameterFile
- alg.MAPLAYER: QgsProcessingParameterMapLayer
- alg.MATRIX: QgsProcessingParameterMatrix
- alg.MULTILAYER: QgsProcessingParameterMultipleLayers
- alg.POINT: QgsProcessingParameterPoint
- alg.GEOMETRY: QgsProcessingParameterGeometry
- alg.RANGE: QgsProcessingParameterRange
- alg.VECTOR_LAYER: QgsProcessingParameterVectorLayer
- alg.AUTH_CFG: QgsProcessingParameterAuthConfig
- alg.MESH_LAYER: QgsProcessingParameterMeshLayer
- alg.SCALE: QgsProcessingParameterScale
- alg.LAYOUT: QgsProcessingParameterLayout
- alg.LAYOUT_ITEM: QgsProcessingParameterLayoutItem
- alg.COLOR: QgsProcessingParameterColor
- alg.DATETIME: QgsProcessingParameterDateTime(type=QgsProcessingParameterDateTime.Type.DateTime)
- alg.DATE: QgsProcessingParameterDateTime(type=QgsProcessingParameterDateTime.Type.Date)
- alg.TIME: QgsProcessingParameterDateTime(type=QgsProcessingParameterDateTime.Type.Time)
- alg.MAP_THEME: QgsProcessingParameterMapTheme
- alg.PROVIDER_CONNECTION: QgsProcessingParameterProviderConnection
- alg.DATABASE_SCHEMA: QgsProcessingParameterDatabaseSchema
- alg.DATABASE_TABLE: QgsProcessingParameterDatabaseTable
- alg.COORDINATE_OPERATION: QgsProcessingParameterCoordinateOperation
- alg.POINTCLOUD_LAYER: QgsProcessingParameterPointCloudLayer
- alg.ANNOTATION_LAYER: QgsProcessingParameterAnnotationLayer
:param type: The type of the input. This should be a type define on `alg` like alg.STRING, alg.DISTANCE
:keyword label: The label of the output. Translates into `description` arg.