4 ms·
Great example. A code browser is on our radar, but it would be a big enough undertaking to do "right" that it hasn't made the cut for low hanging fruit. Our nex
by montanalow 13y ago
Great example. A code browser is on our radar, but it would be a big enough undertaking to do "right" that it hasn't made the cut for low hanging fruit. Our next step may be to just hyperlink all methods/classes/constants in the source to their docs, and from there, the real work left will be front end js.
P.S. Omniref documents "private" methods, even rdoc's :nodoc: methods, with their source. Mainly because of this problem, Ruby documentation isn't complete unless you can view the entire implementation.
- chrisseaton 13y agoMost Ruby implementations have some kind of inline cache - they remember at each call site what object you normally see there, and what method you're normally calling. Could you get that data out and use it to report the correct method at each call site?
- montanalow 13y agoThe dynamism of ruby does make things difficult, if not impossible, to fully realize until runtime. Incidentally, tests are popular in ruby, and give us runtime examples to work with for stronger analysis. If we're just spitballing, as big as TDD is in rubyland, I'd love to see tests themselves become first class documentation, built with the rest of the class docs as yet another form of annotation.