Macaulay2 » Documentation
Packages » Macaulay2Doc > The Macaulay2 language > writing documentation > EXAMPLE
next | previous | forward | backward | up | index | toc

EXAMPLE -- hypertext EXAMPLE item



If the table is included in the input provided to document, the input string will be evaluated by installPackage and the result will be displayed in the documentation. Each object of class PRE will be inserted unchanged into the documentation as example output. For example, the code

EXAMPLE { "1+1" }

produces a display that looks like this:

i1 : 1+1

o1 = 2

See also

Ways to use EXAMPLE :

For the programmer

The object EXAMPLE is a method function with a single argument.