RDoc documentation of iterators

[Stephan Kämper]

Hi all,

when I run rdoc on my code, I think the iterator doc is slightly wrong -
or am I wrong?

If the code is, for example:

class Foo
def each
3.times{ |i| yield i }
end
end

I get this rdoc:

....
Public Instance methods

each() {|i }| ...}

I think the 1st '}' shouldn't be there.

BTW I'm using the 1.8.1-13-rc2 Win installer.

Happy rubying

Stephan

 

[Gavin Sinclair]

class Foo # :yield: i ^^^^^^^^^^^
def each
3.times{ |i| yield i }
end
end

will get you what you want.

Cheers,
Gavin

 

[Dave Thomas]

Hi all,

when I run rdoc on my code, I think the iterator doc is slightly wrong
- or am I wrong?

each() {|i }| ...}

I think the 1st '}' shouldn't be there.

That's a bug: I've fixed it in the latest CVS versions.

Thanks for the report and the testcase.


Cheers

Dave