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

DOC: special: add docstrings for kei, ker, keip, and kerp #11115

Merged
merged 1 commit into from
Nov 30, 2019

Conversation

person142
Copy link
Member

Reference issue

None.

What does this implement/fix?

This adds full docstrings for some of the Kelvin functions.

Additional information

None.

@person142 person142 added Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.special labels Nov 23, 2019
@person142 person142 added this to the 1.5.0 milestone Nov 23, 2019
Copy link
Member

@ev-br ev-br left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM modulo an optional suggestion

--------
ker : the corresponding real part
keip : the derivative of kei

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe also add kv (optional)

@ev-br
Copy link
Member

ev-br commented Nov 30, 2019

Refguide-check failure is unrelated, merging. Thanks Josh!

@ev-br ev-br merged commit 5958e9f into scipy:master Nov 30, 2019
@person142 person142 deleted the kelvin-doc branch November 30, 2019 19:54
@person142 person142 added the special-docs-marathon Part of the NumFOCUS small grant for special function documentation (Do not delete) label Nov 30, 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 special-docs-marathon Part of the NumFOCUS small grant for special function documentation (Do not delete)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants