Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Error in documentation scipy.special.modstruve #10161

Closed
ashwinxsingh opened this issue May 10, 2019 · 0 comments
Closed

Error in documentation scipy.special.modstruve #10161

ashwinxsingh opened this issue May 10, 2019 · 0 comments
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.special
Milestone

Comments

@ashwinxsingh
Copy link

The documentation for the scipy.special.modstruve function says that modstruve is defined as -iexp(-i\nu\pi/2)H_\nu(z) when it should be iexp(-i\nu\pi/2)H_\nu(iz). Without the iz in the argument of the struve function, the modified struve function becomes complex for real inputs and this is not consistent with the output of scipy.special.modstruve, nor the definition cited in https://dlmf.nist.gov/11.2. This is a quick fix, literally just change the z to an iz in the argument of H in the docstring only, not the actual function.

Reproducing code example:

Sample code to reproduce the problem

Error message:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  ...

Scipy/Numpy/Python version information:

@ilayn ilayn added Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.special labels May 10, 2019
@pv pv closed this as completed in 07c036b May 11, 2019
@ilayn ilayn added this to the 1.4.0 milestone May 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.special
Projects
None yet
Development

No branches or pull requests

2 participants