[GRASS-dev] reStructuredText description of a module interface

Vaclav Petras wenzeslaus at gmail.com
Sun Dec 21 19:06:00 PST 2014


Hi,

the modules can generate reStructuredText description of the interface. If
I remember correctly, it is not used anywhere now but it could be
advantageous for some cases, so I would definitively keep it. From g.parser
manual page:

reStructuredText (REST)
       The flag --rest-description added to a GRASS command generates a
related help page template in reStructuredText. Example:
       v.in.db --rest-description

However, --rest-description is misleading since it usually refers to REST
(Representational state transfer) rather than to reStructuredText. So, I
would suggest to change --rest-description to --rst-description. "rst" is a
suffix commonly used for reStructuredText files (used also in GRASS GIS).
Anybody against the change?

Vaclav
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/grass-dev/attachments/20141221/1386cf66/attachment.html>


More information about the grass-dev mailing list