Add examples

Bug #482357 reported by Duncan McGreggor
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
txAWS
Won't Fix
Medium
Unassigned

Bug Description

This ticket has been superseded by the following blueprint:
  https://blueprints.edge.launchpad.net/txaws/+spec/scripts-for-txaws

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.

Changed in txaws:
importance: Undecided → Medium
Revision history for this message
Robert Collins (lifeless) wrote : Re: [Bug 482357] [NEW] Add examples

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

Revision history for this message
Duncan McGreggor (oubiwann) wrote :

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

Revision history for this message
Robert Collins (lifeless) wrote :

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

Revision history for this message
Duncan McGreggor (oubiwann) wrote :

Ah! Yes, that's a great idea! I'll close this ticket as "wontfix" and add a new one.

Thanks!

Changed in txaws:
status: New → Won't Fix
description: updated
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.