diff options
author | Ross Barnowski <rossbar@berkeley.edu> | 2020-09-09 16:22:15 -0700 |
---|---|---|
committer | Ross Barnowski <rossbar@berkeley.edu> | 2020-09-09 16:22:15 -0700 |
commit | 31fbcf5a3b094768a2f9d362ada8bc5df7b4754a (patch) | |
tree | 988041f0e73b757da2a1054d086cef08be97b540 | |
parent | fef19578d79dffd9310cc8d155c631bcfd1bcd9e (diff) | |
download | numpy-31fbcf5a3b094768a2f9d362ada8bc5df7b4754a.tar.gz |
DOC: add autosummary of emath functions
-rw-r--r-- | numpy/core/code_generators/ufunc_docstrings.py | 2 | ||||
-rw-r--r-- | numpy/lib/scimath.py | 16 |
2 files changed, 17 insertions, 1 deletions
diff --git a/numpy/core/code_generators/ufunc_docstrings.py b/numpy/core/code_generators/ufunc_docstrings.py index 93e3d45fb..82cd6fb27 100644 --- a/numpy/core/code_generators/ufunc_docstrings.py +++ b/numpy/core/code_generators/ufunc_docstrings.py @@ -3596,7 +3596,7 @@ add_newdoc('numpy.core.umath', 'sqrt', See Also -------- - numpy.lib.scimath.sqrt + lib.scimath.sqrt A version which returns complex numbers when given negative reals. Notes diff --git a/numpy/lib/scimath.py b/numpy/lib/scimath.py index 555a3d5a8..2b0d38c37 100644 --- a/numpy/lib/scimath.py +++ b/numpy/lib/scimath.py @@ -14,6 +14,22 @@ module provide the mathematically valid answers in the complex plane:: Similarly, `sqrt`, other base logarithms, `power` and trig functions are correctly handled. See their respective docstrings for specific examples. +Functions +--------- + +.. autosummary:: + :toctree: generated/ + + sqrt + log + log2 + logn + log10 + power + arccos + arcsin + arctanh + """ import numpy.core.numeric as nx import numpy.core.numerictypes as nt |