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

Consequences -- side-effects of a function in a documentation node

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 crossreferences to the documentation ", TO "Key" }}

Functions with optional argument named Consequences :

For the programmer

The object Consequences is a symbol.