From: Trans Date: 2008-08-14T23:58:18+09:00 Subject: Re: Documenting DSLs On Aug 14, 7:42 am, Phlip wrote: > Trans wrote: > > > Hey, has anyone thought about or worked on a "next gen" documentation > > system for handling Ruby DSLs? > > I always figured a literate documentor would... > >   - read the code >   - convert the comments to HTML >   - run the tests >   - insert the test code into the HTML >   - syntax-highlight the code >   - insert the test results into the HTML > > That satisfies the goal "tests are documentation". That's a tall order! I'm not sure about mixing the tests into the docs though. That can be a lot a tests and could obscure the docs. Nonetheless I'm sure there are ways. > But when I tried to submit a proposal, with an introductory patch, to the > maintainers of RDoc, I got flamed and I gave up. Great community here... Hmmm.. well I imagine that's bound to happen at times. I would just take to mean that your idea is too futuristic for RDoc, and really needs a new project. T.