Raises docs should link to the exception type

Brought to you by: edloper

#69 Raises docs should link to the exception type

Status: open

Owner: nobody

Labels: None

Priority: 5

Updated: 2007-10-18

Created: 2007-10-18

Creator: Anonymous

Private: No

If I add the reStructuredText format doc string:

:Raises FooError:
when stuff breaks

A link to FooError should be provided in the resulting html documentation.

Discussion

Nobody/Anonymous - 2007-10-19

Logged In: NO

Sorry, I should have specified that this doesn't work for *builtin* exceptions such as ValueError. It already works fine for user-defined exceptions.

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Nobody/Anonymous - 2007-10-19

Logged In: NO

Sorry, that would only work if you were also documenting the built-ins. Never mind. Please resolve this ticket.

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Log in to post a comment.