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. Advertisements

  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. Advertisements

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:
    481
  2. OKB (not okblacke)

    deepcopy raises TypeError for method/function?

    OKB (not okblacke), Sep 9, 2004, in forum: Python
    Replies:
    3
    Views:
    578
    Alex Martelli
    Sep 10, 2004
  3. Andreas Schwarz
    Replies:
    6
    Views:
    500
    Randy W. Sims
    Jan 1, 2004
  4. Brian Schröder
    Replies:
    5
    Views:
    316
    Dave Thomas
    Sep 18, 2004
  5. Daniel Berger
    Replies:
    1
    Views:
    262
    Dave Thomas
    Nov 2, 2004
  6. 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:
    351
    Stefan Lang
    Apr 26, 2005
  7. Paul Van Delst

    How to use rdoc parsers outside of rdoc?

    Paul Van Delst, Jul 27, 2006, in forum: Ruby
    Replies:
    0
    Views:
    211
    Paul Van Delst
    Jul 27, 2006
  8. Jesper Rønn-Jensen
    Replies:
    4
    Views:
    328
    Joel VanderWerf
    Feb 22, 2008
Loading...