docs suck. Need nicer docs please!

Bug #505832 reported by Robert Collins
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
testresources
Triaged
Wishlist
Unassigned

Bug Description

In particular, some examples, a HOWTO and better pydocness.

Revision history for this message
James Westby (james-w) wrote :

In fact it seems the README lies quite a bit, for instance, it indicates that you should
override getResource and doesn't mention make, that TestCases will have self._attribute
set to the resource, whereas it seems to be self.attribute.

I imagine that they may be out of date, and while more docs would be great, the current
ones are incorrect, or at least misleading, and it would be great to fix that as a start.

Thanks,

James

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

I certainly agree. I've just pushed out 0.2.3 with some known issues fixed, but the docs do still need this overhaul.

Changed in testresources:
status: New → Triaged
importance: Undecided → Critical
Changed in testresources:
importance: Critical → Wishlist
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.