[GRASS-dev] [GRASS GIS] #2794: Manual: Overly long description lines

GRASS GIS trac at osgeo.org
Sun Nov 8 11:30:17 PST 2015

#2794: Manual: Overly long description lines
  Reporter:  neteler      |      Owner:  grass-dev@…
      Type:  defect       |     Status:  new
  Priority:  normal       |  Milestone:  7.0.3
 Component:  Docs         |    Version:  svn-releasebranch70
Resolution:               |   Keywords:  manual
       CPU:  Unspecified  |   Platform:  All

Comment (by wenzeslaus):

 I agree, some of them are really long. We have description and when it is
 long we add also label which is supposed to be shorter. However, I have no
 idea to what it translates in `apropos`. I guess my question is if we need
 to shorten the description or put there a label.

 When we are at it might be useful to thing about the preferred grammar.
 Should it be

 cat (1)              - concatenate files and print on the standard output

 which is what `cat` has there or

 cat (1)              - Concatenates files and print on the standard

 which is what most GRASS modules are using. This relates also to the
 suggestion for short labels I for menu which should use the imperative and
 be just 2-3 long as I [https://lists.osgeo.org/pipermail/grass-
 dev/2015-October/077134.html recently mentioned].

Ticket URL: <https://trac.osgeo.org/grass/ticket/2794#comment:2>
GRASS GIS <https://grass.osgeo.org>

More information about the grass-dev mailing list