next | previous | forward | backward | up | top | index | toc | Macaulay2 website
Macaulay2Doc > The Macaulay2 language > writing documentation > document > Inputs

Inputs -- inputs for a function in a documentation node

Synopsis

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

Functions with optional argument named Inputs :

For the programmer

The object Inputs is a symbol.