[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [bug-recutils] [bug #41602] doc: @kbd for long option names
From: |
Jose E. Marchesi |
Subject: |
Re: [bug-recutils] [bug #41602] doc: @kbd for long option names |
Date: |
Mon, 17 Feb 2014 22:57:32 +0100 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/24.3.50 (gnu/linux) |
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.
Hm, I am so used to see that way of documenting the long option names in
the coreutils manual that I used it without thinking... does this mean
that the markup in the coreutils manual is also senseless?