documentation

[vlion]

Hi,

I'm looking for a non-coding project to help out with that can be done in chunks. (I do programming work basically 40 hrs/wk). denise suggested documentation.

What files can use some documentation?

Comments

[denise]

The thing I can really think of is ESN, the notifications system. Things like how to create a new notification type, how to process notifications, etc, etc.

It might take forever to learn how it all works, but as it stands, it's so badly documented, and it's a major barrier!

[yvi]

Oh Gosh, yes.

[exor674]

I think all the LJ::User functions need documenting too.

[denise]

Oh God, having comments on every function in User.pm saying what it does, what it expects as args, etc, etc, would make me weep for joy.

Tears. Seriously. Of joy.

(..also, if it were combined with checking to see if any of the functions aren't called anywhere anymore ... or did we already do that?)

[exor674]

I'd totally love if it was all POD too, cause http://hack.dreamwidth.net/dev/docs/LJ/User.html = very yay

( p.s. whoever does that, make sure my patch on http://bugs.dwscoalition.org/show_bug.cgi?id=2422 is applied first as that adds headers to each section, and use =head3 for the methods )

[pauamma]

Yes to PODifying. (And in fact, that could be a good thing to work on too, in addition to/instead of documenting the overall design and functioning of large things like ESN.