search

zapnap / rdocinfo

New development has moved to http://github.com/lsegal/rubydoc.info
http://rdoc.info
MIT License
18 stars 3 forks source link

Better method rendering #43

Closed ghost closed 14 years ago

ghost commented 14 years ago

While I like rdoc.info overall, there is one part that really irks me -- they way methods are rendered.

The main thing is the '(Type)' return value listed before each one. This isn't Java. Ruby is dynamically typed, so most of the time that is simply meaningless. Rather than putting it before, put it after, as in

foo_method -> Boolean

And if it's just Object, don't put anything at all.

Also the '-'/'+' prefix. Pretty esoteric. How about a nice icon to distinguish them.

zapnap commented 14 years ago

rdoc.info uses YARD to generate project docs and a slightly-modified template for rendering. Fwiw, the method representation is stock. You might want to raise this as an issue with the YARD project if you feel strongly about it.

ghost commented 14 years ago

I posted the issue there. Thanks.