Macaulay2 » Documentation
Packages » Macaulay2Doc > The Macaulay2 language > writing documentation > document > Caveat

next | previous | forward | backward | up | index | toc

Caveat -- warnings or limitations listed in a documentation node

Synopsis

Usage:

document { ... , Caveat => {"warning"}, ... }

Description

This part of the documentation serves to highlight pitfalls for the user.

Functions with optional argument named Caveat :

document(...,Caveat=>...)

For the programmer

The object Caveat is a symbol.