diff options
| author | endolith <endolith@gmail.com> | 2015-09-01 20:11:57 -0400 |
|---|---|---|
| committer | endolith <endolith@gmail.com> | 2015-09-01 20:11:57 -0400 |
| commit | 9111018dc423b01ea79d5a56a548ea7392db1b84 (patch) | |
| tree | 74eea2f4f81f13da0a6cbac606f356a422bf2b34 | |
| parent | 1bd6c31548f7557a5e9a0a5886bcedc975487d3b (diff) | |
| download | numpy-9111018dc423b01ea79d5a56a548ea7392db1b84.tar.gz | |
DOC: Note that all imports need to be explicit
except `np`
| -rw-r--r-- | doc/HOWTO_DOCUMENT.rst.txt | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/HOWTO_DOCUMENT.rst.txt b/doc/HOWTO_DOCUMENT.rst.txt index ac58c7ade..fc046c29c 100644 --- a/doc/HOWTO_DOCUMENT.rst.txt +++ b/doc/HOWTO_DOCUMENT.rst.txt @@ -455,7 +455,8 @@ The sections of the docstring are: The examples may assume that ``import numpy as np`` is executed before the example code in *numpy*. Additional examples may make use of *matplotlib* for plotting, but should import it explicitly, e.g., - ``import matplotlib.pyplot as plt``. + ``import matplotlib.pyplot as plt``. All other imports, including the + demonstrated function, must be explicit. Documenting classes |