next | previous | forward | backward | up | top | index | toc | Macaulay2 website

SimpleDoc :: testExample

testExample -- an example of a test string

Synopsis

Usage:

testExample

Description

The variable testExample is a String containing an example of the use of TEST(String) to write a test case.

TEST /// -* test for simpleDocFrob *-
  assert(simpleDocFrob(2,matrix{{1,2}}) == matrix{{1,2,0,0},{0,0,1,2}})
///

The check method executes all package tests defined this way.

i1 : check SimpleDoc
 -- capturing check(0, "SimpleDoc")                                          -- 0.069053 seconds elapsed

See also

TEST -- add a test for a package
check -- perform tests of a package
packageTemplate -- a template for a package
docExample -- an example of a documentation string

For the programmer

The object testExample is a string.