testAudit -- produce a test audit report for a package

Usage:

testAudit pkg

testAudit(pkg, CommentReport => true, SpeedReport => true, ScoreReport => true)
Inputs:
- pkg, a package or a string,
Optional inputs:
- CommentReport => a Boolean value, default value false
- SpeedReport => a Boolean value, default value false
- ScoreReport => a Boolean value, default value false
- Experimental (missing documentation) => ..., default value false,
Outputs:
- a string, the audit report

Description

Returns a string report about the tests of pkg. The default report summarizes test sources, test organization, untested exported functions and options, silenced tests, and FIXME or TODO markers around test blocks.

Optional Boolean arguments add sections: CommentReport includes comments attached to tests, SpeedReport times tests with check, and ScoreReport includes the heuristic score returned by testScore.

i1 : testAudit "TestAudit"

o1 = exported: 2 functions, 0 types, 4 other symbols
     n_tests: 5
     style: together

     test sources:
         - ../TestAudit.m2:614

     Report:

     - untested functions (0):
         none

     - untested options (1):
         - testAudit: Experimental

     - silenced tests (0):
         none

     - FIXME/TODO markers (0):
         none

Ways to use testAudit:

testAudit(Package)
testAudit(String)

For the programmer

The object testAudit is a method function with options.

The source of this document is in TestAudit.m2:588:0.

testAudit -- produce a test audit report for a package

Description

See also

Ways to use testAudit:

For the programmer