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

[qgib]

Author Name: Nikos Alexandris (Nikos Alexandris)
Original Redmine Issue: 21322
Affected QGIS version: 3.5(master)
Redmine category:documentation_and_help

---

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

ParameterRaster|base|base|False

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.

[qgib]

Author Name: Giovanni Manghi (@gioman)

---

• category_id was changed from Processing/GRASS to Documentation and Help

[Pedro-Murteira]

It is no longer possible to confirm the validity of this issue due to the links not being accessible.

[neteler]

@Pedro-Murteira The current links are

• https://github.com/qgis/QGIS/blob/master/python/plugins/grassprovider/grass.txt
• https://github.com/qgis/QGIS/tree/master/python/plugins/grassprovider/description/

(updated in May 2024)

[Pedro-Murteira]

@neteler Thank you. This is still valid.