[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[bug-recutils] [bug #41602] doc: @kbd for long option names

From: Karl Berry
Subject: [bug-recutils] [bug #41602] doc: @kbd for long option names
Date: Sat, 15 Feb 2014 17:12:47 +0000
User-agent: Mozilla/5.0 (X11; Linux i686; rv:27.0) Gecko/20100101 Firefox/27.0 SeaMonkey/2.24


                 Summary: doc: @kbd for long option names
                 Project: GNU recutils
            Submitted by: karl
            Submitted on: Sat 15 Feb 2014 09:12:46 AM PST
                Category: None
                Severity: 3 - Normal
              Item Group: None
                  Status: None
                 Privacy: Public
             Assigned to: None
             Open/Closed: Open
         Discussion Lock: Any



I didn't include it in my patch because it seemed too invasive, but I think
using @kbd for long option names in the summaries is bad.  For one thing, you
don't use it for single-character names.  For another, those simply are not
keyboard input, so it's semantically wrong.  For a third, it creates a visual
ambiguity between option names and meta-variables, as in
@address@hidden  For a fourth, you don't do it

Please consider removing all those spurious-IMHO @kbd's.

The @w{...} at the beginning of an @item also seems senseless, but at least
that is harmless.


Reply to this item at:


  Message sent via/by Savannah

reply via email to

[Prev in Thread] Current Thread [Next in Thread]