[lnkForumImage]
TotalShareware - Download Free Software
Confronta i prezzi di migliaia di prodotti.
Asp Forum
 Home | Login | Register | Search 


 

Forums >

comp.lang.ruby

Re: [ANN] Dhaka-1.0.0 now with RDoc

Gregory Brown

1/9/2007 9:30:00 PM

On 1/8/07, Mushfeq Khan <mushfeq.khan@gmail.com> wrote:

> 3) Dhaka now has an RDoc. It's a lot of work, but a pretty small API! Thanks
> to Gregory Brown for requesting this. I hope it helps.

Hi Mushfeq. Thanks for mentioning me!

The RDoc is certainly helpful. It'd be great if you also included a
simple code example for some of the most important classes. The big
examples are awesome for showing the depth of your very cool work, but
it's a little tough to figure out how to do small tasks.

I'm interested in getting hacking with Dhaka, so I'll keep an eye on
the project for sure.

warm regards,
-greg
1 Answer

Gregory Brown

1/10/2007 5:35:00 AM

0

On 1/9/07, Mushfeq Khan <mushfeq.khan@gmail.com> wrote:
> Hi,
>
> I'll start including more code in the RDocs. The most important classes -
> really the only important classes - are Grammar, Tokenizer and Evaluator.
> These are where the hacking occurs. While the test suites contain several
> examples of each class, they are admittedly complex. I'm strongly for the
> idea that good examples are the best kind of explanation, the simpler the
> better. If you have ideas for such examples, let me know.

Something like parsing CSV or JSON would be a great reference. Both
have fairly simple rules...
Thanks for pointing at these classes. What we tried to do in Ruport
(though it needs updating!) is have our readme display as the front of
the RDoc and do a quick description of the most important classes
right in the Readme, so people know right where to go.

Maybe that'd help make it easier for folks to find the relevant docs
in Dhaka as well.