launchpad-dev team mailing list archive

[Jonathan Lange <jml@xxxxxxxxxxxxx>]

On Mon, Mar 1, 2010 at 7:19 AM, Julian Edwards
<julian.edwards@xxxxxxxxxxxxx> wrote:
> On Monday 01 March 2010 12:10:43 Jonathan Lange wrote:
...
>> (Also, what makes model objects so special anyway?)
>
> Precedent.  Pretty much most of our model objects already have this.  Our doc
> strings are mostly awful and where they are not awful they are mediocre.
>

What I meant was, why does this kind of class need documentation more
than any other kind of class?

> I think the doc tests should still be about how to drive the object (or "doing
> something useful with it" like you say).
>

I guess I'm saying that starting from the class itself isn't such a great idea.

> The doc strings should be like a reference where you already know how to drive
> it but need help on a specific function/method.
>

+1

jml