Opened 4 years ago

Closed 3 months 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

Description

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.

Attachments (1)

output.txt (396 bytes) - added by vincent 3 months ago.
apropos output

Download all attachments as: .zip

Change History (11)

comment:1 Changed 4 years ago by martinl

Milestone: 7.0.27.0.3

Lets move milestone to 7.0.3

comment:2 Changed 4 years ago 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 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 Changed 3 years ago by neteler

Milestone: 7.0.3

Ticket retargeted after milestone closed

comment:4 Changed 3 years ago by neteler

Milestone: 7.0.4

Ticket retargeted after 7.0.3 milestone closed

comment:5 Changed 3 years ago by martinl

Milestone: 7.0.47.0.5

comment:6 Changed 3 years ago by neteler

Milestone: 7.0.57.0.6

comment:7 Changed 17 months ago by neteler

Milestone: 7.0.67.0.7

comment:8 Changed 3 months ago by martinl

Still relevant?

comment:9 Changed 3 months ago by 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

?

Changed 3 months ago by vincent

Attachment: output.txt added

apropos output

comment:10 Changed 3 months ago by neteler

Milestone: 7.0.77.2.0
Resolution: fixed
Status: newclosed

Thanks.

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

Closing.

Note: See TracTickets for help on using tickets.