diff options
| author | Travis Oliphant <oliphant@enthought.com> | 2007-12-30 09:59:39 +0000 |
|---|---|---|
| committer | Travis Oliphant <oliphant@enthought.com> | 2007-12-30 09:59:39 +0000 |
| commit | 5896cb8c7aba4477bd9d09fb94a129ee2e8ad11a (patch) | |
| tree | 11e58ced538774029ee3af849552b0c84a4e4604 | |
| parent | fdeac7465818652d5fb31e7e0e27f9debd0f54b8 (diff) | |
| download | numpy-5896cb8c7aba4477bd9d09fb94a129ee2e8ad11a.tar.gz | |
Add a Raises section to the docstring suggestions.
| -rw-r--r-- | numpy/doc/HOWTO_DOCUMENT.txt | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/numpy/doc/HOWTO_DOCUMENT.txt b/numpy/doc/HOWTO_DOCUMENT.txt index 4c32013ee..bb147068d 100644 --- a/numpy/doc/HOWTO_DOCUMENT.txt +++ b/numpy/doc/HOWTO_DOCUMENT.txt @@ -89,7 +89,11 @@ The proposed sections of the docstring are: functions with a large number of keyword argument can still be well documented without cluttering the main parameters' list. -6. **See also:** +6. **Raises:** + An optional section detailing which errors get raised under what + conditions. + +7. **See also:** An optional section used to refer to related code. This section can be very useful, but should be used judiciously. The goal is to direct users to other functions they may not be aware of, or have @@ -97,13 +101,13 @@ The proposed sections of the docstring are: example). Routines whose docstrings further explain parameters used by this function are good candidates. -7. **Notes:** +8. **Notes:** An optional section that provides additional information about the code, possibly including a discussion of the algorithm. This section may include mathematical equations, possibly written in `LaTeX <http://www.latex-project.org/>`__. -8. **Examples:** +9. **Examples:** An optional section for examples, using the `doctest <http://www.python.org/doc/lib/module-doctest.html>`__ format. It can provide an inline mini-tutorial as well as additional |