gtg-user team mailing list archive
-
gtg-user team
-
Mailing list archive
-
Message #00097
Re: Why not docstrings?
On Sun, Jul 12, 2009 at 9:17 PM, Lionel Dricot<ploum@xxxxxxxxx> wrote:
> Hello,
>
> Pitijo has started a branch to convert the codebase to docstring but I
> have no news from him.
>
> And yes, it should be done, ideally ;-)
>
I've uploaded a branch that add a 'make apidocs' target, and fixes up
a few of our docstrings to have correct markup.
You can see an example here:
http://static.mumak.net/gtg-api/
If you think it's worthwhile, I can arrange to have that page kept
permanently up to date (but tbh, I'd rather not).
The branch is at
https://code.edge.launchpad.net/~jml/gtg/doc-generation/+merge/9020. I
have another branch waiting for review, but it's a lot bigger & less
interesting, and should be landed after the doc-generation branch in
case of conflicts.
jml
Follow ups
References