[GRASS-dev] manual pages: trac new modules/params/flags

Hi all,

it would make sense to add to the modules manual pages information in
which version the module has been introduced. We can start with
r.streams.* modules which were added recently to trunk/relbr70. It
would be also nice to track newly added parameters or flags.

There are several options, one of them is a new <h2> section, eg.

<h2>Find a nice name for new section</h2>

Module <em>r.mymodule</em> added in GRASS 7.0.

<ul>
<li>Parameter <b>newparam</b> added in GRASS 7.1.
</ul>

What do you think? Martin

--
Martin Landa * http://geo.fsv.cvut.cz/gwiki/Landa

On Wed, Apr 2, 2014 at 11:59 PM, Martin Landa <landa.martin@gmail.com> wrote:

Hi all,

it would make sense to add to the modules manual pages information in
which version the module has been introduced. We can start with
r.streams.* modules which were added recently to trunk/relbr70.

This would be very good. Perhaps it is not even too much effort
(something for train rides) to add it for most modules, using a
scripted approach of scanning the manual pages and ChangeLogs.

It would be also nice to track newly added parameters or flags.

There are several options, one of them is a new <h2> section, eg.

<h2>Find a nice name for new section</h2>

Module <em>r.mymodule</em> added in GRASS 7.0.

<ul>
<li>Parameter <b>newparam</b> added in GRASS 7.1.
</ul>

What do you think?

... I dunno with that level of detail: I would use the energy to first
get the manual pages complete, i.e. adding examples where still
missing.

Markus

On Wed, Apr 2, 2014 at 6:16 PM, Markus Neteler <neteler@osgeo.org> wrote:

> <ul>
> <li>Parameter <b>newparam</b> added in GRASS 7.1.
> </ul>
>
> What do you think?

... I dunno with that level of detail: I would use the energy to first
get the manual pages complete, i.e. adding examples where still
missing.

Hm, I can see that it can be useful sometimes. For example, Python have
this for each function which in our case might be closer to
parameters/options then to modules, in terms of level of details. However,
if I should choose between examples in manual and version for each
parameter/option, I choose the example.

Speaking about examples, each module, in my opinion, should have also and
image in manual even if it does not convey any important information as in
case of `r.in.lidar`.

http://grass.osgeo.org/grass70/manuals/r.in.lidar.html