[GRASS-dev] reStructuredText description of a module interface

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

Hi,

2014-12-22 4:06 GMT+01:00 Vaclav Petras <wenzeslaus@gmail.com>:

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?

not all, I would highly agree with this change. Martin

--
Martin Landa
http://geo.fsv.cvut.cz/gwiki/Landa
http://gismentors.eu/mentors/landa

On Thu, Dec 25, 2014 at 1:17 PM, Martin Landa <landa.martin@gmail.com>
wrote:

Hi,

2014-12-22 4:06 GMT+01:00 Vaclav Petras <wenzeslaus@gmail.com>:
> 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?

not all, I would highly agree with this change. Martin

Implemented in r63780 but just the rename. Unfortunately, I cannot replace

all occurrences of "rest" (as in reStructuredText) in the source code now.

Anyway, we should get back to this topic. There is a lot of code
related to reStructuredText
in GRASS and it might be quite useful for different things.

http://trac.osgeo.org/grass/changeset/63780

--
Martin Landa
http://geo.fsv.cvut.cz/gwiki/Landa
http://gismentors.eu/mentors/landa