Macaulay2 » Documentation
Packages » Macaulay2Doc » The Macaulay2 language » writing documentation » document » Inputs

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

Inputs -- inputs for a function in a documentation node

Usage:

document { ... , Inputs => { inputs, ... }, ... }

Description

The entries should consist of items in one of the following forms.

hypertext
class
symbolname
class => hypertext
symbolname => class
symbolname => hypertext
symbolname => class => hypertext

As an example, here is the Inputs entry of the method resolution(Ideal):

Inputs => { "I" => { "an ideal in a ring ", TT "R", ", say" } }

Here is an example of the Inputs entry of the function sin:

Inputs => { "x" => RR },

See also

Outputs -- outputs for a function in a documentation node
Usage -- ways to use a function in a documentation node

Functions with optional argument named Inputs:

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

For the programmer

The object Inputs is a symbol.

The source of this document is in /build/macaulay2-88fgJW/macaulay2-1.25.11+ds/M2/Macaulay2/packages/Macaulay2Doc/functions/document-doc.m2:461:0.