# simpleDocFrob -- a sample documentation node

## Synopsis

• Usage:
x = simpleDocFrob(n,M)
• Inputs:
• n, an integer, positive;
• M, , which is square;
• Optional inputs:
• Limit => an integer, default value 0, as an Option; multiline descriptions are sometimes useful
• Outputs:
• x, , A block diagonal matrix with n copies of M along the diagonal
• Consequences:
• The first side effect of the function, if any, is described here.
• The second side effect of the function is described here, and so on.

## Description

Each paragraph of text begins with "Text". The following line starts a sequence of Macaulay2 example input lines.

The output in the following example was automatically generated at the time of package installation.

 i1 : M = matrix"1,2;3,4"; 2 2 o1 : Matrix ZZ <--- ZZ i2 : simpleDocFrob(3,M) o2 = | 1 2 0 0 0 0 | | 3 4 0 0 0 0 | | 0 0 1 2 0 0 | | 0 0 3 4 0 0 | | 0 0 0 0 1 2 | | 0 0 0 0 3 4 | 6 6 o2 : Matrix ZZ <--- ZZ

## A new section

The following example was generated by the documentation author.

 i1 : 4+ 4 o1 = 8 i1000 : 2+2 o1000 = 4

See docExample for the code used to create this documentation.

## a different way to use this method

• Usage:
simpleDocFrom_n M
• Inputs:
• Outputs:
• ,
• Consequences:
• There may be specific consequences.

Paragraph specific to this usage. Itemized lists can be created with the "Tree" keyword:

• matrix(List) -- create a matrix from a doubly-nested list of ring elements or matrices
• ZZ -- the class of all integers
• Matrix -- the class of all matrices

## Acknowledgement

Acknowledge funding sources or collaborators here.

## Contributors

Acknowledge contributors who are not listed as authors here.

## Caveat

This is not a particularly useful function.