Comment 3 for bug 482357

Revision history for this message
Robert Collins (lifeless) wrote : Re: [Bug 482357] [NEW] Add examples

On Tue, 2009-11-17 at 20:55 +0000, Duncan McGreggor wrote:

> Well... not really -- bin/aws-status is essentially empty ;-)
>
> What Free had in mind was something along the lines of example usage. I
> will likely create a branch with an examples directory with files in
> doctest format similar to this:
>
> http://bazaar.launchpad.net/~txspore-dev-team/txspore/trunk/annotate/head:/docs/USAGE.txt
>
> The benefits being:
> 1) it's easily readable by people who know Python
> 2) the example is testable

I think my point was that another way of doing it would be to improve
the user accessible tools we offer. Both gtk and cli tools would be
great things to have, and if written well can show how to use the API
too. (Particularly if we keep the API layers nicely separated).

-Rob