next | previous | forward | backward | up | top | index | toc | Macaulay2 web site
Macaulay2Doc :: Usage

Usage -- shows the usage of a function

Synopsis

Description

The Usage entry should give a formal example showing the usage of the function. The variables used in this formal example should be the ones used in the Inputs and Outputs sections of the documentation. Here is the code for the Usage entry of the method matrix(List):
Usage => "matrix v"
Here is the code for the Usage entry of the method resolution(Module):
Usage => "resolution M\nres M"

This option also can be used within a SYNOPSIS section.

Functions with optional argument named Usage :

See also

For the programmer

The object Usage is a symbol.