next | previous | forward | backward | up | top | index | toc | Macaulay2 web site
Macaulay2Doc :: document(..., Consequences => ...)

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

Synopsis

Description

Here is where one documents effects of a function that 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

See also