grass icon indicating copy to clipboard operation
grass copied to clipboard

[Bug] New g.parser manual page has an unexpected title

Open echoix opened this issue 8 months ago • 4 comments

Describe the bug

g.parser has a weird title in the new docs.

To reproduce

I recently found out that the new manual pages are published online (yay! they are so nice!). I was looking at g.tempfile, then I wanted to see other g.* commands with a similar name. Since there isn't a sidebar with the other function names, I clicked on the keyword/tag at the top, and got the following:

Image

I found the tool called Provides full parser support for GRASS scripts unexpected, so I checked it out. It is finally g.parser, but it isn't obvious.

Expected behavior

The tool is called g.parser and not Provides full parser support for GRASS scripts.

Screenshots

Image

System description

Additional context

echoix avatar Apr 13 '25 15:04 echoix

This is a larger issue with the conversion to markdown from html. The pages in questions include an extra first level markdown header #. MkDocs gets the first level header from the yaml metadata name. To correct this we need to updated the impacted files. Which can be found by filtering the files with the regex ^# and limiting the search to include only markdown files ( thanks @echoix).

cwhite911 avatar May 20 '25 15:05 cwhite911

Here is an example from g.gui.example.md.

Incorrect

---
description: wxGUI Example Tool
index: wxGUI
---

# wxGUI Example Tool

## DESCRIPTION

The purpose of the **Example Tool** is to make life easier for new wxGUI
developers. It can serve as a basic template when creating standalone
GRASS GUI-based application. Example tool can display one raster map a
show information about it.

Corrected

---
title: g.gui.example
description: wxGUI Example Tool
index: wxGUI
---

## DESCRIPTION

The purpose of the **Example Tool** is to make life easier for new wxGUI
developers. It can serve as a basic template when creating standalone
GRASS GUI-based application. Example tool can display one raster map a
show information about it.

cwhite911 avatar May 20 '25 15:05 cwhite911

List of files probably to fix:

db/drivers/dbf/grass-dbf.md
db/drivers/mysql/grass-mesql.md
db/drivers/mysql/grass-mysql.md
db/drivers/odbc/grass-odbc.md
db/drivers/ogr/grass-ogr.md
db/drivers/postgres/grass-pg.md
db/drivers/sqlite/grass-sqlite.md
doc/examples/gui/wxpython/g.gui.example.md
doc/gui/wxpython/example/g.gui.example.md
general/g.parser/g.parser.md
gui/wxpython/animation/g.gui.animation.md
gui/wxpython/datacatalog/g.gui.datacatalog.md
gui/wxpython/dbmgr/g.gui.dbmgr.md
gui/wxpython/gcp/g.gui.gcp.md
gui/wxpython/gmodeler/g.gui.gmodeler.md
gui/wxpython/iclass/g.gui.iclass.md
gui/wxpython/image2target/g.gui.image2target.md
gui/wxpython/mapswipe/g.gui.mapswipe.md
gui/wxpython/photo2image/g.gui.photo2image.md
gui/wxpython/psmap/g.gui.psmap.md
gui/wxpython/rdigit/g.gui.rdigit.md
gui/wxpython/rlisetup/g.gui.rlisetup.md
gui/wxpython/timeline/g.gui.timeline.md
gui/wxpython/tplot/g.gui.tplot.md
gui/wxpython/vdigit/g.gui.vdigit.md
raster/r.li/r.li.md

echoix avatar May 20 '25 15:05 echoix

@wenzeslaus when working on PR https://github.com/OSGeo/grass/pull/5169/files do you remember if there was a reason for setting the title using # instead of setting the title in the page metadata?

cwhite911 avatar May 21 '25 18:05 cwhite911