Macaulay2 » Documentation
Packages » Macaulay2Doc » The Macaulay2 language » writing documentation » document » BaseFunction
next | previous | forward | backward | up | index | toc

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.


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