diff options
| author | Travis Oliphant <oliphant@enthought.com> | 2007-12-26 23:04:04 +0000 |
|---|---|---|
| committer | Travis Oliphant <oliphant@enthought.com> | 2007-12-26 23:04:04 +0000 |
| commit | 80db3b32f2d5532bdd8bc8f66ce2103bd4e64ea1 (patch) | |
| tree | 4d0a9fd32a411fe2e5bd2a5b5b090b6ba8ceccbb /numpy/doc | |
| parent | 87f61abda82e21fc77facd3931e0182dd564c3a0 (diff) | |
| download | numpy-80db3b32f2d5532bdd8bc8f66ce2103bd4e64ea1.tar.gz | |
Fix packbits and unpackbits for new io in numpy.
Diffstat (limited to 'numpy/doc')
| -rw-r--r-- | numpy/doc/HOWTO_DOCUMENT.txt | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/numpy/doc/HOWTO_DOCUMENT.txt b/numpy/doc/HOWTO_DOCUMENT.txt index e7de660ad..8b1230ad1 100644 --- a/numpy/doc/HOWTO_DOCUMENT.txt +++ b/numpy/doc/HOWTO_DOCUMENT.txt @@ -17,6 +17,7 @@ Additional PEPs of interest regarding documentation of code: Use a code checker: * `pylint <http://www.logilab.org/857>`__ + * `pyflakes` easy_install pyflakes * `pep8.py <http://svn.browsershots.org/trunk/devtools/pep8/pep8.py>`__ Common import standards:: @@ -32,7 +33,8 @@ function, class, or method definition. The docstring is a special attribute of the object (``object.__doc__``) and, for consistency, is surrounded by triple double quotes. -It is highly desireable that both NumPy and SciPy_ follow a common +It is highly desireable that both NumPy and SciPy_ and scikits to +follow a common convention for docstrings that provide for consistency while also allowing epydoc_ to produce nicely-formatted reference guides. This document describes the current community consensus for this standard. |