bugGNU recutils - Bugs: bug #41602, doc: @kbd for long option names

 
 

bug #41602: doc: @kbd for long option names

Submitter:  Karl Berry <karl>
Submitted:  Sat 15 Feb 2014 05:12:46 PM UTC
   
 
Category:  None Severity:  3 - Normal
Item Group:  None Status:  Fixed
Privacy:  Public Assigned to:  None
Open/Closed:  Closed
* Mandatory Fields

Add a New Comment Rich Markup
   

Sat 15 Feb 2014 05:12:46 PM UTC, original submission:  

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 @kbd{--type}=@var{type}.  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.

Karl Berry <karl>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by jemarch (Updated the item)
  • -email is unavailable- added by karl (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only logged-in users can vote.

     

    Follow 2 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2014-02-25 jemarch StatusNone Fixed
        Open/ClosedOpen Closed

    Back to the top

    Powered by Savane 3.13-d3ae.
    Corresponding source code