rdoc Question: How to document which exceptions a function raises

Discussion in 'Ruby' started by Brian Schröder, Sep 26, 2004.

  1. Hello Group,

    is there already a possibility in rdoc to document which exceptions a
    function raises? Somethink like the :yield: keyword.

    I did not find anything in the rdoc documentation.

    regards,

    Brian Schröder
     
    Brian Schröder, Sep 26, 2004
    #1
    1. Advertising

  2. On Sun, 26 Sep 2004 21:50:27 +0900, Brian Schröder
    <> wrote:
    > Hello Group,
    >
    > is there already a possibility in rdoc to document which exceptions a
    > function raises? Somethink like the :yield: keyword.
    >
    > I did not find anything in the rdoc documentation.


    Best to write it out if you must document it. Having something more or
    less automatically generated leads to the concept of "checked"
    exceptions, which C++ and Java users are now realising were a huge
    mistake.

    -austin
    --
    Austin Ziegler *
    * Alternate:
    : as of this email, I have [ 6 ] Gmail invitations
     
    Austin Ziegler, Sep 26, 2004
    #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. seth
    Replies:
    0
    Views:
    354
  2. OKB (not okblacke)

    deepcopy raises TypeError for method/function?

    OKB (not okblacke), Sep 9, 2004, in forum: Python
    Replies:
    3
    Views:
    403
    Alex Martelli
    Sep 10, 2004
  3. Andreas Schwarz
    Replies:
    6
    Views:
    258
    Randy W. Sims
    Jan 1, 2004
  4. Daniel Berger
    Replies:
    1
    Views:
    146
    Dave Thomas
    Nov 2, 2004
  5. Jesper Rønn-Jensen
    Replies:
    4
    Views:
    140
    Joel VanderWerf
    Feb 22, 2008
Loading...

Share This Page