TEST -- add a test for a package

Synopsis

Usage:

TEST s
Inputs:
- s, a string, or list of strings, containing Macaulay2 code
Optional inputs:
- FileName => a Boolean value, default value false, if true, then s (or each element of s, if it is a list) is interpreted as the name of a file containing a test as opposed to the test itself.
Consequences:
- registers the string s as a test of the current package.

Description

This function should only occur in the documentation section of a package; i.e., after beginDocumentation. Use check to run all of the tests associated to a package.

For an example, see docExample and an example of a package.

If a test should be skipped when running check, e.g., it is known to fail under certain circumstances, then the comment -* no-check-flag *- may be added to s.

Caveat

When creating tests, try to ensure that they run relatively quickly.

Ways to use TEST :

TEST(List)
TEST(String)

For the programmer

The object TEST is a method function with options.