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

## Synopsis

• Usage:
document { ... , Consequences => { "side-effects" }, ... }

## 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" }}

## Functions with optional argument named Consequences :

• "document(...,Consequences=>...)"
• "SYNOPSIS(...,Consequences=>...)" -- see SYNOPSIS -- a standardized synopsis for use in documentation nodes

## For the programmer

The object Consequences is .