next | previous | forward | backward | up | top | index | toc | Macaulay2 web site
Macaulay2Doc :: function documentation template

function documentation template

document {
     Key => (functionName, argumentClass1, argumentClass2, ...),
     Headline => "one line description", -- only if different functionName Headline
     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