Comment 2 for bug 482357

Revision history for this message
Duncan McGreggor (oubiwann) wrote : Re: [Bug 482357] [NEW] Add examples

Robert Collins wrote:
> On Fri, 2009-11-13 at 21:03 +0000, Duncan McGreggor wrote:
>> Public bug reported:
>>
>> In a code review, Free Ekanayaka suggested that before txAWS is
>> released, we should add some specific examples showing how to use the
>> EC2 client.
>
> Like bin/aws-status ?
>
> -Rob

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

d