Pugs documentation & comments

[Stuart Cook]

As a newcomer to the Pugs project, I figured I would try to first read
the code and understand what it does. Unfortunately, without a handy
architectural overview or a reference to all the various custom types,
that can be pretty tricky.

Thus I'm interested in adding documentation and comments to Pugs, both
as a learning exercise for myself, and as an aid to future
contributors.

I seem to recall a mention of Haddock on #perl6, but I'm not sure if
that's leading anywhere. Is anyone else interested?

Stuart

[Stevan Little]

Stuart,

I have been planning on doing much the same thing to try and increase
my understanding of Haskell (although my free time is fairly limited
lately).

Autrijus had recommended beginning with src/Eval.hs and using the
Haddock tool (http://haskell.org/haddock/). You are welcome to start
right there.

If you need svn commit access, just ask on #perl6 and someone will be
glad to give it to you.

Also if you look in docs/src/ there is a Junc.hs and a Junc.pod which
was created by metaperl earlier in the project. This might be helpful
for you as well.

Stevan

[Stuart Cook]

On 4/29/05, Stevan Little <ste...@iinteractive.com> wrote:
> Autrijus had recommended beginning with src/Eval.hs and using the
> Haddock tool (http://haskell.org/haddock/). You are welcome to start
> right there.

I've made some headway in understanding Eval.hs, but it seems to rely
pretty heavily on AST.hs, so I may focus my attention there for now.
Now that Haddock can actually process the whole source tree, I should
be able to make some progress.

Stuart