Macaulay2 » Documentation
Packages » Macaulay2Doc > The Macaulay2 language > creating a package > TEST
next | previous | forward | backward | up | index | toc

TEST -- add a test for a package



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.


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

See also

Ways to use TEST :

For the programmer

The object TEST is a method function with options.