schwern/test-more — Issue #172: Combine EventCoodinator docs into TestState
Author: schwern
Created: 2011-11-04 21:49:59+00:00
State: open
Labels: DO IT, Docs, Gardening, Test-Builder2

TestState delegates to EventCoordinator. Users will be primarily interacting with TestState so it would be nice if they could see the documentation for its complete interface in one place. But it's much easier to write the docs for TestState and EventCoordinator in place.

To get the best of both worlds, we need a tool which can copy the relevant bits of EventCoordinator's docs into TestState's docs. The result would be output as `TestState.pod` which perldoc will pick up before `TestState.pm`. The user sees unified docs, EventCoordinator still has docs, and we can write them split.

Write a tool, and if necessary restructure the TestState and EventCoordinator docs, to do this.

Don't worry about integrating it into the build system.