next | previous | forward | backward | up | top | index | toc | home

Usage -- shows the usage of a function

Synopsis

Usage:
document { ... , Usage => "usage", ... }
Function: document

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"

Functions with optional argument named Usage :

document(..., Usage => ...) -- missing documentation
SYNOPSIS(..., Usage => ...) -- missing documentation

See also

document -- package item: documentation node
Inputs -- inputs for a function
Outputs -- outputs for a function

For the programmer

The object Usage is a symbol.