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

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.


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