Skip to content

[Bug] manual: multi-tools and multi-addons lack short descriptions #4972

@neteler

Description

@neteler

Describe the bug

All multi-tools (r.li, i.sentinel addon, etc.) have a "meta" manual page.

Traditionally, these contained the full HTML header/footer (example), since no parser-related compilation is involved and the HTML file was copied as-is into the target manual subdirectory.

For a short period of time (I could not identify when the change happened), the reduced manual page structure starting with "DESCRIPTION" and without footer is apparently also accepted, and the full manual pages are built.

GRASS GIS core

Core example r.li meta manual page:

Yet the title is not turned into a description:

https://grass.osgeo.org/grass84/manuals/raster.html

  • [...]
  • r.li.edgedensity Calculates edge density index on a raster map, using a 4 neighbour algorithm
  • r.li <== empty
  • r.li.mpa Calculates mean pixel attribute index on a raster map
  • r.li.mps Calculates mean patch size index on a raster map, using a 4 neighbour algorithm
  • [...]

GRASS GIS addons:

A similar problem arises with addons:

https://grass.osgeo.org/grass84/manuals/addons/

Only those meta manual pages which still contain full headers/footers are fine.

Expected behavior

The current manual magic needs to be fixed/expanded to carry over the title as short description.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocsmanualDocumentation related issues

    Type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions