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

 
 

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

Submitted by:  Karl Berry <karl>
Submitted on:  Sat 15 Feb 2014 05:12:46 PM UTC  
 
Category: NoneSeverity: 3 - Normal
Item Group: NoneStatus: Fixed
Privacy: PublicAssigned to: None
Open/Closed: Closed

Add a New Comment(Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

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 File(s):
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

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

    Do you think this task is very important?
    If so, you can click here to add your encouragement to it.
    This task has 0 encouragements so far.

    Only logged-in users can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    Follow 2 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Tue 25 Feb 2014 12:01:29 AM UTCjemarchStatusNone=>Fixed
      Open/ClosedOpen=>Closed

    Back to the top


    Powered by Savane 3.1-cleanup1