diff options
| author | Matthias Bussonnier <bussonniermatthias@gmail.com> | 2018-04-09 12:14:24 -0700 |
|---|---|---|
| committer | Matthias Bussonnier <bussonniermatthias@gmail.com> | 2018-04-09 13:37:08 -0700 |
| commit | f2f17210a5e5824a9977d63957c09bbe5d64eda2 (patch) | |
| tree | 87b038e19a81522011b8ee40e587879865949575 /numpy/add_newdocs.py | |
| parent | 07d590c980edb05f1ef67cd27fff2ffe2d9c6047 (diff) | |
| download | numpy-f2f17210a5e5824a9977d63957c09bbe5d64eda2.tar.gz | |
Cross Link full/full_like in a few see-also.
While teaching numpy I was asked the best way to create an array of nan,
and `np.full` seem not be cross linked from many places; In particular
in the documentation of `zeros` and `ones` seam like obvious candidates
to add them.
Reorder all the see-also to be
- empty_like
- ones_like
- zero_like
- full_like
- empty
- ones
- zeros
- full
Diffstat (limited to 'numpy/add_newdocs.py')
| -rw-r--r-- | numpy/add_newdocs.py | 29 |
1 files changed, 24 insertions, 5 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py index 0a7b2b13d..88d6df184 100644 --- a/numpy/add_newdocs.py +++ b/numpy/add_newdocs.py @@ -784,7 +784,15 @@ add_newdoc('numpy.core.multiarray', 'array', See Also -------- - empty, empty_like, zeros, zeros_like, ones, ones_like, full, full_like + empty_like : Return an empty array with shape and type of input. + ones_like : Return an array of ones with shape and type of input. + zeros_like : Return an array of zeros with shape and type of input. + full_like : Return a new array with shape of input filled with value. + empty : Return a new uninitialized array. + ones : Return a new array setting values to one. + zeros : Return a new array setting values to zero. + full : Return a new array of given shape filled with value. + Notes ----- @@ -862,7 +870,14 @@ add_newdoc('numpy.core.multiarray', 'empty', See Also -------- - empty_like, zeros, ones + empty_like : Return an empty array with shape and type of input. + ones_like : Return an array of ones with shape and type of input. + zeros_like : Return an array of zeros with shape and type of input. + full_like : Return a new array with shape of input filled with value. + ones : Return a new array setting values to one. + zeros : Return a new array setting values to zero. + full : Return a new array of given shape filled with value. + Notes ----- @@ -920,9 +935,11 @@ add_newdoc('numpy.core.multiarray', 'empty_like', -------- ones_like : Return an array of ones with shape and type of input. zeros_like : Return an array of zeros with shape and type of input. + full_like : Return a new array with shape of input filled with value. empty : Return a new uninitialized array. ones : Return a new array setting values to one. zeros : Return a new array setting values to zero. + full : Return a new array of given shape filled with value. Notes ----- @@ -983,11 +1000,13 @@ add_newdoc('numpy.core.multiarray', 'zeros', See Also -------- - zeros_like : Return an array of zeros with shape and type of input. - ones_like : Return an array of ones with shape and type of input. empty_like : Return an empty array with shape and type of input. - ones : Return a new array setting values to one. + ones_like : Return an array of ones with shape and type of input. + zeros_like : Return an array of zeros with shape and type of input. + full_like : Return a new array with shape of input filled with value. empty : Return a new uninitialized array. + ones : Return a new array setting values to one. + full : Return a new array of given shape filled with value. Examples -------- |