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

# undocumented -- declare that something need not be documented

- Usage:
    `undocumented key`
- Inputs:
  - key, a thing, a documentation key, or a list of keys
- Consequences:
  - the documentation key(s) are designated as keys not needing documentation, thus avoiding warning messages when a package is installed.

## Description

    i1 : f = method()

    o1 = f

    o1 : MethodFunction

    i2 : f List := x -> 1

    o2 = FunctionClosure[currentString:2:10-2:16]

    o2 : FunctionClosure

    i3 : f VisibleList := x -> 2

    o3 = FunctionClosure[currentString:3:17-3:23]

    o3 : FunctionClosure

    i4 : f BasicList := x -> 3

    o4 = FunctionClosure[currentString:4:15-4:21]

    o4 : FunctionClosure

    i5 : undocumented { f, (f,List) }

## See also

- installPackage -- load and install a package and its documentation
- documentation keys

## Ways to use undocumented:

- `undocumented(List)`
- `undocumented(Thing)`

## For the programmer

The object undocumented is a method function with a single argument.

The source of this document is in /build/macaulay2-88fgJW/macaulay2-1.25.11+ds/M2/Macaulay2/packages/Macaulay2Doc/functions/document-doc.m2:665:0.