diff options
author | Jesús Carrete Montaña <jesus.carrete.montana@tuwien.ac.at> | 2022-05-19 22:44:57 +0200 |
---|---|---|
committer | Jesús Carrete Montaña <jesus.carrete.montana@tuwien.ac.at> | 2022-05-19 22:44:57 +0200 |
commit | df5efc4e1a8e2d53f71543310f4589dcc509e047 (patch) | |
tree | c0c568c840197826f4f795bf38e7d1da0f53ec20 /numpy/array_api/_statistical_functions.py | |
parent | 57961d233b4eda080a52999e4f97f98d1651b588 (diff) | |
download | numpy-df5efc4e1a8e2d53f71543310f4589dcc509e047.tar.gz |
DOC: improve the docstring of numpy.sinc to explain behavior at zero.
The first lines of the sinc docstring did not mention the behavior
when the argument is zero, and gave the impression that the function is
defined as the quotient between a sine and its argument everywhere. That
information was instead relegated to the "Notes" section. I found this
issue while navigating the documentation for jax.numpy.sinc, which
inherits those few lines. I think it is important to document not only
the value of the function at zero, but also that it make sinc a smooth
function. This connects better with some of the other routes used to
introduce sinc (e.g. as a Taylor series). I have tried to implement
the conclusions of the discussion around Issue #21538, keeping the
description close to the actual implementation and avoiding my original
suggestion of introducing the function as a limit.
Diffstat (limited to 'numpy/array_api/_statistical_functions.py')
0 files changed, 0 insertions, 0 deletions