Autopilot docs should include testtools documentation

Bug #1427748 reported by Nicholas Skaggs
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Autopilot
New
Undecided
Unassigned

Bug Description

At the moment it is confusing for folks to reference the autopilot documentation and pull up the autopilot.testcase module and see only a few methods being discussed. The fact autopilot.testcase inherits from testtools.testcase is only casually mentioned with no link. We should include testtools.TestCase capabilities inside autopilot.testcase as well.

Likewise, autopilot.matchers shows only a single matcher, Eventually. While indeed this is the only matcher autopilot adds on top of testtools, the other testtools matchers are not mentioned and remain confusing for developers trying to use the tool.

In addition to integrating the testtools documentation, we should more explicitly state that autopilot is built upon it and provide external links for more information.

Tags: docs
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.