[ruby-talk:04243] Re: Method signature - a question for the group

Mathieu Bouchard <[e-mail]> writes:

> > We also describe in the text that follows the circumstances under
> > which nil is returned.  The problem is that these "or nil"s appear
> > all over the place (and we're discovered places where they're
> > missing), and they mess up the layout of the method definitions
> > somewhat. So, we were wondering: do people feel they're useful to
> > include in the signature, or is noting them in the accompanying
> > text good enough?
> >       str.index( aString ) -> aFixnum or nil
> 
> Please include them, simply because nil is not a fixnum, and so one has to
> check the return value, and act accordingly. it's as simple as that.

We just went through and did just that. We've posted the latest
version (which we hope is the final version) to
http://dev.rubycentral.com/ref. I'm sure we have some html conversion
issues, but the content should be pretty close to complete. If anyone
finds any problems, now's the time to say!

Thanks


Dave & Andy