diff options
| author | Matti Picus <matti.picus@gmail.com> | 2019-04-16 19:22:33 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-04-16 19:22:33 +0300 |
| commit | 4c977804b4eaadf5ac1b4eb1024f8167657e976d (patch) | |
| tree | a7580d0a32e27b103cf619fdc7e8ebe1940e1361 /numpy | |
| parent | 500b5d9b039ae1cac60280f195be1fa773e676c9 (diff) | |
| parent | 46d01eac68a09e9fd4b09c50b8c3b36dd85907f0 (diff) | |
| download | numpy-4c977804b4eaadf5ac1b4eb1024f8167657e976d.tar.gz | |
Merge pull request #13337 from kritisingh1/conj
DOC: Add docstrings for consistency in aliases
Diffstat (limited to 'numpy')
| -rw-r--r-- | numpy/core/code_generators/ufunc_docstrings.py | 8 |
1 files changed, 8 insertions, 0 deletions
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 -------- |