diff options
| author | kritisingh1 <kritisingh1.ks@gmail.com> | 2019-04-15 19:39:35 +0530 |
|---|---|---|
| committer | kritisingh1 <kritisingh1.ks@gmail.com> | 2019-04-16 12:19:17 +0530 |
| commit | 46d01eac68a09e9fd4b09c50b8c3b36dd85907f0 (patch) | |
| tree | 8e238ef906de5c40746411c4085c65aebc21d9fb | |
| parent | dea1239b6dcaf072fc9b70e6af0c0a100cead69e (diff) | |
| download | numpy-46d01eac68a09e9fd4b09c50b8c3b36dd85907f0.tar.gz | |
DOC: Add docstrings for consistency in aliases
| -rw-r--r-- | doc/source/reference/routines.math.rst | 1 | ||||
| -rw-r--r-- | doc/source/reference/ufuncs.rst | 1 | ||||
| -rw-r--r-- | numpy/core/code_generators/ufunc_docstrings.py | 8 |
3 files changed, 10 insertions, 0 deletions
diff --git a/doc/source/reference/routines.math.rst b/doc/source/reference/routines.math.rst index 821363987..3c2f96830 100644 --- a/doc/source/reference/routines.math.rst +++ b/doc/source/reference/routines.math.rst @@ -141,6 +141,7 @@ Handling complex numbers real imag conj + conjugate Miscellaneous diff --git a/doc/source/reference/ufuncs.rst b/doc/source/reference/ufuncs.rst index e2981b40e..c71c8c9a7 100644 --- a/doc/source/reference/ufuncs.rst +++ b/doc/source/reference/ufuncs.rst @@ -586,6 +586,7 @@ Math operations sign heaviside conj + conjugate exp exp2 log diff --git a/numpy/core/code_generators/ufunc_docstrings.py b/numpy/core/code_generators/ufunc_docstrings.py index 7591a7952..8b1a5a3db 100644 --- a/numpy/core/code_generators/ufunc_docstrings.py +++ b/numpy/core/code_generators/ufunc_docstrings.py @@ -793,6 +793,13 @@ add_newdoc('numpy.core.umath', 'conjugate', The complex conjugate of `x`, with same dtype as `y`. $OUT_SCALAR_1 + Notes + ----- + `conj` is an alias for `conjugate`: + + >>> np.conj is np.conjugate + True + Examples -------- >>> np.conjugate(1+2j) @@ -3079,6 +3086,7 @@ add_newdoc('numpy.core.umath', 'remainder', ----- Returns 0 when `x2` is 0 and both `x1` and `x2` are (arrays of) integers. + ``mod`` is an alias of ``remainder``. Examples -------- |