forked from Perl-Toolchain-Gang/Test-Harness
-
Notifications
You must be signed in to change notification settings - Fork 0
Missing documentation for 'rules' and 'scheduler' in Test::Harness App::Prove
markstos edited this page Aug 18, 2012
·
8 revisions
Here's a list of places where documentation "scheduling" and "rules" in TAP::Harness / App::Prove is known to be missing. It can be serve as a To-Do list to remedy the situation.
-
provehas a --rules flag, but is not documented. --rules can repeated multiple times and appears that it expects values like this: ** par=GLOB - indicates that the following file path, with glob-style wildcards, is able to run in parallel ** seq=GLOB - indicates that the following file path, with glob-style wildcards, must be run serially. - App::Prove mentions 'rules' without further documentation. However, it's not clear that more is necessary here, if
proveis properly documented.
- new() should document that it takes 2 arguments ** 'tests' - ( just a bunch of file paths? ) ** 'rules' - a hashref of "rule" data, defaulting to { par => '**' }. *** An explanation of the data structure should be linked to, if not included.
- The as_string() should include a simple of the output generated.
- Should link to TAP::Parser::Scheduler::Spinner and TAP::Parser::Scheduler::Job
- When the docs say "next job", I think they mean a TAP::Parser::Scheduler::Job object. This should be clarified.
- new() contains a third argument, "context", which is not document
- The "$name" argument to new() should be clarified to be a file name.
- The docs refer to every method as a "Class Method". This appears to be a mistake. Only new() appears to be a class method.
- The "filename", "description", and "context" methods are all undocumented. They appear to be "Attributes".