<?xml version="1.0" encoding="utf-8" ?> <!-- for emacs: -*- coding: utf-8 -*- -->
<!-- Apache may like this line in the file .htaccess: AddCharset utf-8 .html -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg-flat.dtd" >
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head><title>conventions for documentation</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="_copy__Directory_lp..._cm_sp__Update__Only_sp_eq_gt_sp..._rp.html">next</a> | <a href="_contract_lp__Matrix_cm__Matrix_rp.html">previous</a> | <a href="_copy__Directory_lp..._cm_sp__Update__Only_sp_eq_gt_sp..._rp.html">forward</a> | <a href="_contract_lp__Matrix_cm__Matrix_rp.html">backward</a> | up | <a href="index.html">top</a> | <a href="master.html">index</a> | <a href="toc.html">toc</a> | <a href="http://www.math.uiuc.edu/Macaulay2/">Macaulay2 web site</a></div>
</td>
</tr>
</table>
<hr/>
<div><h1>conventions for documentation</h1>
<div>While not hard and fast rules, keeping these stylistic conventions in mind makes for easier reading by users<ul><li>Start with a documentation template, see <a href="_writing_spdocumentation.html" title="">writing documentation</a>.</li>
<li><a href="_document_lp..._cm_sp__Inputs_sp_eq_gt_sp..._rp.html" title="inputs for a function">Inputs</a>, <a href="_document_lp..._cm_sp__Outputs_sp_eq_gt_sp..._rp.html" title="outputs for a function">Outputs</a>, and <a href="_document_lp..._cm_sp__Consequences_sp_eq_gt_sp..._rp.html" title="side-effects of a function">Consequences</a>should not end with periods.</li>
</ul>
</div>
</div>
</body>
</html>
