Plurals in RDoc documentation

Discussion in 'Ruby' started by Perry Smith, Jan 23, 2011.

  1. Perry Smith

    Perry Smith Guest

    I can't find my post from yesterday. Sorry if this is a repeat.

    What is the best way to create a reference to a class where the
    sentence requires the use of the plural form. For example, "list of
    Widgets". RDoc will not create a link to the Widget class. The
    closest I can come is "list of Widgets[link:Widget.html]" but that
    assumes about how RDoc is going to lay stuff out which might change.

    Right now I'm doing "list of Widget s" which is a bit silly.

    Thank you in advance for your help

    Perry

    --
    Posted via http://www.ruby-forum.com/.
     
    Perry Smith, Jan 23, 2011
    #1
    1. Advertising

  2. Perry Smith

    Eric Hodel Guest

    On Jan 22, 2011, at 18:26, Perry Smith <> wrote:

    > I can't find my post from yesterday. Sorry if this is a repeat.
    >=20
    > What is the best way to create a reference to a class where the
    > sentence requires the use of the plural form. For example, "list of
    > Widgets". RDoc will not create a link to the Widget class. The
    > closest I can come is "list of Widgets[link:Widget.html]" but that
    > assumes about how RDoc is going to lay stuff out which might change.
    >=20
    > Right now I'm doing "list of Widget s" which is a bit silly.
    >=20
    > Thank you in advance for your help


    This annoys me too. I have not decided to automatically link plural class na=
    mes but I am tempted to do so.

    Please post an issue on https://github.com/rdoc/rdoc so I can remember=
     
    Eric Hodel, Jan 23, 2011
    #2
    1. Advertising

Want to reply to this thread or ask your own question?

It takes just 2 minutes to sign up (and it's free!). Just click the sign up button to choose a username and then you can ask your own questions on the forum.
Similar Threads
  1. Andreas Schwarz
    Replies:
    6
    Views:
    263
    Randy W. Sims
    Jan 1, 2004
  2. Brian Schröder
    Replies:
    5
    Views:
    146
    Dave Thomas
    Sep 18, 2004
  3. Daniel Berger
    Replies:
    1
    Views:
    147
    Dave Thomas
    Nov 2, 2004
  4. Iwan van der Kleyn

    rdoc: how to add readme.rdoc as index.html?

    Iwan van der Kleyn, Apr 26, 2005, in forum: Ruby
    Replies:
    1
    Views:
    245
    Stefan Lang
    Apr 26, 2005
  5. Paul Van Delst

    How to use rdoc parsers outside of rdoc?

    Paul Van Delst, Jul 27, 2006, in forum: Ruby
    Replies:
    0
    Views:
    112
    Paul Van Delst
    Jul 27, 2006
Loading...

Share This Page