diff options
| author | Charles Harris <charlesr.harris@gmail.com> | 2016-06-17 11:08:43 -0600 |
|---|---|---|
| committer | Charles Harris <charlesr.harris@gmail.com> | 2016-06-17 11:31:23 -0600 |
| commit | 71c18e964e36f3875db867ae45b6e22fb551ae85 (patch) | |
| tree | 346c31ee289f6eaf189a74a15c8735a50918dcb1 /numpy/add_newdocs.py | |
| parent | e22492340f9d89ee77f0dc3fbfcd499c855a9d14 (diff) | |
| download | numpy-71c18e964e36f3875db867ae45b6e22fb551ae85.tar.gz | |
MAINT: Tweak documentation of broadcast.nd and broadcast.ndim.
Note that the newly added `ndim` property is an alias for `nd` and
not available in numpy versions earlier than 1.12.
Add back the tests for `nd`. They can be removed if/when `nd` is
dropped.
Diffstat (limited to 'numpy/add_newdocs.py')
| -rw-r--r-- | numpy/add_newdocs.py | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py index b00673d79..c6ceb29c6 100644 --- a/numpy/add_newdocs.py +++ b/numpy/add_newdocs.py @@ -554,7 +554,7 @@ add_newdoc('numpy.core', 'broadcast', ('iters', add_newdoc('numpy.core', 'broadcast', ('ndim', """ - Number of dimensions of broadcasted result. + Number of dimensions of broadcasted result. Alias for `nd`. .. versionadded:: 1.12.0 @@ -570,7 +570,8 @@ add_newdoc('numpy.core', 'broadcast', ('ndim', add_newdoc('numpy.core', 'broadcast', ('nd', """ - Number of dimensions of broadcasted result. Alias for `ndim`. + Number of dimensions of broadcasted result. For code intended for Numpy + 1.12.0 and later the more consistent `ndim` is preferred. Examples -------- |