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

beginDocumentation -- start documentation section of a package



Documentation for a package, and tests for the package, should be placed after this point in a package file. This way, documentation can be loaded separately, Macaulay2 examples in the documentation can be run, and the whole documentation can be stored in a database.

For an example, see an example of a package.

To write documentation without using the function beginDocumentation, which is just an optimization, use needsPackage to load the packages SimpleDoc and Text.

See also

For the programmer

The object beginDocumentation is a function closure.