next | previous | forward | backward | up | top | index | toc | Macaulay2 website

Macaulay2Doc > The Macaulay2 language > writing documentation > document > BaseFunction

BaseFunction -- the basename of a function in a documentation node

Description

The BaseFunction entry gives the function that uses the feature being documented.

Here is a sample usage of this entry:


BaseFunction => myFunc

Functions with optional argument named `BaseFunction` :

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

For the programmer

The object BaseFunction is a symbol.