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

Usage -- ways to use a function in a documentation node

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.

See also

Functions with optional argument named Usage:

  • SYNOPSIS(...,Usage=>...) -- see SYNOPSIS -- a standardized synopsis for use in documentation nodes
  • document(...,Usage=>...)

For the programmer

The object Usage is a symbol.


The source of this document is in Macaulay2Doc/functions/document-doc.m2:461:0.