Bug report #21322

Documentation file grass7.txt is not up-to-date

Added by Nikos Alexandris over 5 years ago. Updated over 5 years ago.

Category:Documentation and Help
Affected QGIS version:3.5(master) Regression?:No
Operating System: Easy fix?:No
Pull Request or Patch supplied:No Resolution:
Crashes QGIS or corrupts data:No Copied to github as #:29140


The "documentation" file https://github.com/qgis/QGIS/blob/master/python/plugins/processing/algs/grass7/grass7.txt seems not to be up-to-date. The instructions there-in, i.e. the various declarations used in the description files under https://github.com/qgis/QGIS/tree/master/python/plugins/processing/algs/grass7/description are not mentioned. Also, the format of the declarations seems not to be what is described in the grass7.txt file.

For example, for a Raster map, the documentation reads


while declarations in existing description files are

QgsProcessingParameterRasterLayer|input|Name of NDVI raster map [-]|None|False

In this example, not only the declaration "keyword" itself is different ("ParameterRaster" vs. "QgsProcessingParameterRasterLayer") but also the number of succedding elements as well (3 vs. 4).

I am trying to follow what is under the descriptions directory. But I still don't understand all of the formatting.


#1 Updated by Giovanni Manghi over 5 years ago

  • Category changed from Processing/GRASS to Documentation and Help

Also available in: Atom PDF