From: Jeff Rose Date: 2006-06-01T20:26:39+09:00 Subject: Re: Ruby Manual Conor Hunt wrote: > Nathaniel is using my software Rannotate > (http://rubyforge.rannotate.org) to run the site. I had previously > released the same documentation at http://ruby.outertrack.com. > > There are unfortunately a few major issues with documenting Ruby using > Rannotate right now. One issue is mixins. For example with String you > will see a to_yaml() method even though that method is only available if > you do "require 'yaml'". This is a major issue because you will also > find that mixins that override String methods (jcode etc.) will wipe out > the String RDoc with their RDoc. > > I have implemented some RDoc patches and major code changes to Rannotate > to fix the various issues and I will be releasing this soon to > http://ruby.outertrack.com. > > -- > Conor - http://www.conorhunt.com/techblog/ The idea here is cool, even if there are still some kinks to work out. I have a few questions/ideas for you though. It would be helpful it rubymanual.org had a link to rannotate on the page. As people start to use the site they will probably be interested in the system as well... It looks like in the rannotated ruby documentation on outertrack.com there is a lot more info for the classes implemented in C. What's the current support for doing this? How does an admin use the notes? It would be great if the tool could output a patch or a series of patches that could easily be read & applied in an editor (i.e. vim :-). With that in mind, it could be helpful to use rannotate with logins so notes from developers can be automatically applied, while notes from the world could be looked at first. I'm going to try to get it setup in the next few days. Thanks for the great stuff. -Jeff