diff options
| author | Dongjoon Hyun <dongjoon@apache.org> | 2016-02-15 17:14:20 -0800 |
|---|---|---|
| committer | Dongjoon Hyun <dongjoon@apache.org> | 2016-02-15 17:20:18 -0800 |
| commit | aefc290e8f2232dbad8b6df10e4df81421a1a2b2 (patch) | |
| tree | 3a0c3346ec63db565ec33f74707f04ea4c8c8fb6 /doc/example.py | |
| parent | 53c6ef74a7a3cce80f4db581eb708c5e374715b5 (diff) | |
| download | numpy-aefc290e8f2232dbad8b6df10e4df81421a1a2b2.tar.gz | |
DOC: Fix mismatched variable names in docstrings.
Diffstat (limited to 'doc/example.py')
| -rw-r--r-- | doc/example.py | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/example.py b/doc/example.py index 03be59d18..5c891f64c 100644 --- a/doc/example.py +++ b/doc/example.py @@ -5,7 +5,7 @@ this improves readability. Every module should have a docstring at the very top of the file. The module's docstring may extend over multiple lines. If your docstring does extend over multiple lines, the closing three quotation marks must be on -a line by itself, preferably preceeded by a blank line. +a line by itself, preferably preceded by a blank line. """ from __future__ import division, absolute_import, print_function @@ -52,7 +52,7 @@ def foo(var1, var2, long_var_name='hi') : The type above can either refer to an actual Python type (e.g. ``int``), or describe the type of the variable in more detail, e.g. ``(N,) ndarray`` or ``array_like``. - Long_variable_name : {'hi', 'ho'}, optional + long_var_name : {'hi', 'ho'}, optional Choices in brackets, default first when optional. Returns |