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

2014-04-02 Thread Martin Landa
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  section, eg.

Find a nice name for new section

Module r.mymodule added in GRASS 7.0.


Parameter newparam added in GRASS 7.1.


What do you think? Martin

-- 
Martin Landa * http://geo.fsv.cvut.cz/gwiki/Landa
___
grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev


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

2014-04-02 Thread Markus Neteler
On Wed, Apr 2, 2014 at 11:59 PM, Martin Landa  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  section, eg.
>
> Find a nice name for new section
>
> Module r.mymodule added in GRASS 7.0.
>
> 
> Parameter newparam added in GRASS 7.1.
> 
>
> 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
___
grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev


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

2014-04-03 Thread Vaclav Petras
On Wed, Apr 2, 2014 at 6:16 PM, Markus Neteler  wrote:

> > 
> > Parameter newparam added in GRASS 7.1.
> > 
> >
> > 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
___
grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev