This page is a guide to both format and content for pages describing a particular routine. Make sure that you follow it when adding a new routine, and also remember to add 3-5 page tags describing the routine content. It may be useful to copy the code for this page and edit it as necessary, when creating a new routine page.
If a section (such as Error Conditions) does not contain any information, feel free to omit it.
:The code of the routine :should be included here
An explanation of the routine, including how it works, how you can modify it, what variables it uses, and anything else that is important to know when using the routine. The explanation should be thorough enough so that a person can use the routine without requiring help from somebody else.
For the non-generic errors that might occur when using this command (that is, syntax-type errors shouldn't be included). In a format similar to the following:
- ERR:DIM MISMATCH is thrown if the two list arguments have different dimensions.
- ERR:RESERVED is thrown if ∟RESID is supplied as an argument.
There are several routines that are similar in functionality or are used in a similar context. Make a bulleted list of them, with links to the other routines' pages. It will often be the case that several routines all link to each other.
- Routine 1
- Routine 2
- Routine 3