← Back to team overview

gtg-user team mailing list archive

Re: Why not docstrings?

 

Hi Johnathan,

I merged your branch. Thanks again for your work, it's great to see
GTG code quality improve like this.

As for the automatically updated API docs on the web, I don't think it
will useful for now.

Bertrand

On Sun, Jul 19, 2009 at 9:54 AM, Jonathan Lange<jml@xxxxxxxxx> wrote:
> 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
>
> _______________________________________________
> Mailing list: https://launchpad.net/~gtg-user
> Post to     : gtg-user@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~gtg-user
> More help   : https://help.launchpad.net/ListHelp
>



-- 
Bertrand Rousseau
Place communale 1, 1450 Chastre, Belgium
e-mail : bertrand.rousseau@xxxxxxxxx
tel : +32 485 96 69 86



Follow ups

References