Opened 9 years ago

Closed 5 years ago

#2794 closed defect (fixed)

Manual: Overly long description lines

Reported by: neteler Owned by: grass-dev@…
Priority: normal Milestone: 7.2.0
Component: Docs Version: svn-releasebranch70
Keywords: manual Cc:
CPU: Unspecified Platform: All



The top 10 manual pages with too long description line (to be fixed in main.c or the respective file) are

  • d.geodesic
  • r3.neighbors
  • r.cost
  • r.his
  • r.neighbors
  • r.patch
  • r.resamp.rst
  • r.series.accumulate
  • r.walk
  • v.reclass

TODO: Respective one-liner "description"s to be (carefully) shortened.

Attachments (1)

output.txt (396 bytes ) - added by vincent 5 years ago.
apropos output

Download all attachments as: .zip

Change History (11)

comment:1 by martinl, 9 years ago


Lets move milestone to 7.0.3

comment:2 by wenzeslaus, 9 years ago

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 output.

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 recently mentioned.

comment:3 by neteler, 8 years ago

Milestone: 7.0.3

Ticket retargeted after milestone closed

comment:4 by neteler, 8 years ago

Milestone: 7.0.4

Ticket retargeted after 7.0.3 milestone closed

comment:5 by martinl, 8 years ago


comment:6 by neteler, 8 years ago


comment:7 by neteler, 6 years ago


comment:8 by martinl, 5 years ago

Still relevant?

comment:9 by neteler, 5 years ago

I guess so. Can a (Debian) GRASS GIS trunk user please run (as per

apropos -s 1grass .|perl -nlwe 'print length'|sort -rn|uniq -c|head -50


by vincent, 5 years ago

Attachment: output.txt added

apropos output

comment:10 by neteler, 5 years ago

Resolution: fixed
Status: newclosed


The report looks good to me with respect to the originally, meanwhile archived Debian bug report.


Note: See TracTickets for help on using tickets.