[GRASS-dev] Re: [GRASS GIS] #1031: More specific parameter information in command line help

[GRASS GIS]

#1031: More specific parameter information in command line help
--------------------------+-------------------------------------------------
  Reporter:  huhabla      |       Owner:  grass-dev at lists.osgeo.org
      Type:  enhancement  |      Status:  new                      
  Priority:  minor        |   Milestone:  7.0.0                    
 Component:  libgis       |     Version:  svn-trunk                
Resolution:               |    Keywords:  parser, help             
  Platform:  All          |         Cpu:  All                      
--------------------------+-------------------------------------------------
Comment (by hamish):

 most of what you want is already given by usage:

 {{{
 Usage:
  r.buffer [-z] input=name output=name distances=value[,value,...]
    [units=string] [--overwrite] [--verbose] [--quiet]
 }}}

 things in [square] brackets are optional (according to age-old unix
 convention (and prob ms-dos too))

 the 'name' or 'value' on the right side of the equals sign, if not given a
 custom setting by the programmer with opt->key_desc, could perhaps be
 improved. see the tcltk module guis which are quite informative. I think
 we still have some work to do on this for the wx module guis (see also
 #886 for that).


 Hamish

-- 
Ticket URL: <https://trac.osgeo.org/grass/ticket/1031#comment:1>
GRASS GIS <http://grass.osgeo.org>