next | previous | forward | backward | up | top | index | toc | Macaulay2 web site
Macaulay2Doc :: makeDocumentTag

makeDocumentTag -- convert a documentation key to a documentation tag

Synopsis

Description

i1 : makeDocumentTag (res,Module)

o1 = User :: resolution(Module)

o1 : DocumentTag
i2 : peek oo

o2 = DocumentTag{(resolution, Module), resolution(Module), User}
i3 : makeDocumentTag (koszul,ZZ,Matrix)

o3 = User :: koszul(ZZ,Matrix)

o3 : DocumentTag
i4 : peek oo

o4 = DocumentTag{(koszul, ZZ, Matrix), koszul(ZZ,Matrix), User}
i5 : makeDocumentTag [res,PairLimit]

o5 = Macaulay2Doc :: resolution(..., PairLimit => ...)

o5 : DocumentTag
i6 : peek oo

o6 = DocumentTag{[resolution, PairLimit], resolution(..., PairLimit => ...),
     ------------------------------------------------------------------------
     Macaulay2Doc}

See also

Ways to use makeDocumentTag :