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

function documentation template

document {
        Key => {
             functionName,
            (functionName, argumentClass1, argumentClass2, ...)},
        Headline     => "one line description",
        Usage        => "usage",
        Inputs       => {}, -- each input is a hypertext list
        Outputs      => {}, -- each output 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


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