# Re: Error/exception documentation

**URL:** <https://www.ruby-forum.com/t/re-error-exception-documentation/69933>\
**Category:** Ruby\
**Created:** [September 25, 2006, 6:47pm UTC](https://www.ruby-forum.com/t/re-error-exception-documentation/69933 "2006-09-25T18:47:18Z")\
**Posts on this page:** 2\
**Page:** 1

<div class="post-metadata">

**Author:** ![phrogz](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/p/2acd7d/32.png) [@phrogz](https://www.ruby-forum.com/u/phrogz)\
**Post date:** [September 25, 2006, 6:47pm UTC](https://www.ruby-forum.com/t/re-error-exception-documentation/69933/1 "2006-09-25T18:47:18Z")

</div>

From: Chris D. [[mailto:removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid)]

> thx jan, i’ll have a look at it.  
> i still believe it would be better to have this information  
> included in  
> each method description since it really shouldn’t take more than a few  
> seconds to look it up. =)

It definitely should. Ruby’s documentation has been a sore spot for a  
long time, but it’s getting better all the time, quickly.

How? By volunteers writing it. Please feel free to join the ruby-doc  
mailing list and volunteer to begin modifying the documentation to  
include these exceptions as you find them.

(I’m not sure what smiley covers the phrase “Yes, I’m being a smartass,  
but I’m also dead serious. Documentation only gets written when people  
write it.” Perhaps a wink. Let’s go with that.)

😉

---

<div class="post-metadata">

**Author:** ![phrogz](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/p/2acd7d/32.png) [@phrogz](https://www.ruby-forum.com/u/phrogz)\
**Post date:** [September 25, 2006, 7:45pm UTC](https://www.ruby-forum.com/t/re-error-exception-documentation/69933/2 "2006-09-25T19:45:26Z")

</div>

Gavin K. wrote:

> 😉

lol  
you’re right to say so =)  
if i find the time im surely going to try and help a bit with the docs.

cheers chris