diff options
| author | Ralf Gommers <ralf.gommers@googlemail.com> | 2011-03-25 12:13:48 +0100 |
|---|---|---|
| committer | Ralf Gommers <ralf.gommers@googlemail.com> | 2011-03-29 16:24:22 +0200 |
| commit | c343611d512b62964d6fc74fbe4e589b92260e51 (patch) | |
| tree | a811dfb4cbff0c016f59b4d8b90d1af695f236c4 | |
| parent | 9c570e8a220087aa3677c9e5f75d6c3489821373 (diff) | |
| download | numpy-c343611d512b62964d6fc74fbe4e589b92260e51.tar.gz | |
DOC: update class method docstring section of docstandard. Closes #1165.
| -rw-r--r-- | doc/HOWTO_DOCUMENT.rst.txt | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/HOWTO_DOCUMENT.rst.txt b/doc/HOWTO_DOCUMENT.rst.txt index 5c5eb43fb..9afea377f 100644 --- a/doc/HOWTO_DOCUMENT.rst.txt +++ b/doc/HOWTO_DOCUMENT.rst.txt @@ -419,7 +419,11 @@ Note that `self` is *not* listed as the first parameter of methods. Method docstrings ````````````````` Document these as you would any other function. Do not include -``self`` in the list of parameters. +``self`` in the list of parameters. If a method has an equivalent function +(which is the case for many ndarray methods for example), the function +docstring should contain the detailed documentation, and the method docstring +should refer to it. Only put brief summary and See Also sections in the method +docstring. Documenting class instances |