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

# optional argument documentation template

    document {
            Key => {
                 OptionName,
                [functionName, OptionName]},
            Headline     => "one line description",
            Usage        => "usage",
            Inputs       => {}, -- each input is a hypertext list
            Consequences => {}, -- each effect is a hypertext list
            "There can be explanatory prose here in the form of a hypertext list.",
            EXAMPLE {
                "m2code",
                "m2code",
                "m2code"},
            "There can be explanatory prose here in the form of a hypertext list.",
            Caveat => {"warning"}
            }

## See also

- writing documentation
- hypertext list format

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