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

document(..., Consequences => ...) -- side-effects of a function

Synopsis

Usage:
document { ... , Consequences => {"effects" }, ... }
Function: document

Description

Here is where one documents effects of a function which are not return values. As an example here is the Consequences entry for the documentation node Headline:

Consequences => {
          { "the headline string will be used to annotate itemized 
                  lists of cross references to the documentation ", TO "Key" }
          },

Further information

Default value: null
Function: document -- package item: documentation node
Option name: Consequences -- side-effects of a function

See also

document -- package item: documentation node