Manual: Overly long description lines

[neteler]

From ​https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=341643

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.

[martinl]

Lets move milestone to 7.0.3

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

[neteler]

Ticket retargeted after milestone closed

[neteler]

Ticket retargeted after 7.0.3 milestone closed

[martinl]

Still relevant?

[neteler]

I guess so. Can a (Debian) GRASS GIS trunk user please run (as per ​https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=341643#15):

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

?

[vincent]

apropos output

[neteler]

Thanks.

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

Closing.