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

[Karl Berry]

URL:
  <http://savannah.gnu.org/bugs/?41602>

                 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

    _______________________________________________________

Details:

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:

  <http://savannah.gnu.org/bugs/?41602>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/