Headline -- headline of a documentation node

Usage:

document { Key => key, Headline => "one line description", ... }
Consequences:
- the headline string will be used to annotate itemized lists of cross-references to the documentation Key

Description

The headline of a documentation node, gives a brief, half line, description of the thing being documented. As an example, the headline for this documentation node was obtained with the code:

Headline => "make a headline for a documentation node"

Functions with optional argument named Headline:

document(...,Headline=>...)
newPackage(...,Headline=>...) -- see newPackage -- the preamble of a package

For the programmer

The object Headline is a symbol.

The source of this document is in Macaulay2Doc/functions/document-doc.m2:461:0.

Headline -- headline of a documentation node

Description

See also

Functions with optional argument named Headline:

For the programmer