D.9 Documentation

D.9.1 For functions and methods

Write documentation strings for every function always. Also, ensure every defmethod has a defgeneric which has a documentation string. The following formatting should be used for docstrings.

Brief description (maximum 79 characters).

Longer description if necessary. This may span multiple lines, but
should adhere to the standard 79-character limit.

Paragraph breaks are also OK in the longer description.
* PARAM-A description of param
* PARAM-B description of param

D.9.2 For files and modules

Large new functional modules (e.g., a new file of code) should be documented in the manual. The SEL manual is located in the doc/ subdirectory and is written in texinfo. Follow the example set by existing documentation to add new sections to this manual.