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

document(..., Inputs => ...) -- inputs for a function

Synopsis

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 },

Further information

Default value: null
Function: document -- package item: documentation node
Option name: Inputs -- inputs for a function

See also

document -- package item: documentation node
Outputs -- outputs for a function
Usage -- shows the usage of a function