Re: Ruby Docs with annotations and searching

"Conor Hunt" <[email protected]>
Newsgroups gmane.comp.lang.ruby.documentation
Message-ID <[email protected]>
> 1. What purpose does YAML serve for Rannotate?

I needed some way to get the object tree that RDoc generates into a
database and YAML seems like a portable format that is easy to import
into a DB and could even be re-used by other projects.

> 2. Does Rannotate use the Ruby built-in RDoc modules to do its job?

Yes, but instead of using the normal generators (HTML, RI) that it
comes with it uses my YAML generator. I'd like to get this YAML
generator submitted to the ruby codebase even apart from my project.

> 3. Do you see the RA-Ruby site (http://ruby.outertrack.com/) as a way
> to help get more docs into the official Ruby source? That is, do you
> see the maintainer of that site gradually trying to get some of the
> more valuable "comments" into the Ruby source code files?

Yes! Definitely, but I also see it as adding searching, diffing and
other capabilities to the docs. Like this:
http://rails.outertrack.com/history/RaClass/ActionController%3A%3ABase

> 3.1. Do you see any easy way to help automate the process of
> selectively merging choice RA site comments into RDoc in the source
> code files?

I'm open to ideas!

--
Conor
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.