DOC: special.riccati_yn: highlight sign convention
#21603
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mdhaber
added
scipy.special
Documentation
scipy/special/_basic.py
Outdated
| y_n(x)`, where :math:`y_n` is the spherical Bessel function of the second | ||
| kind of order :math:`n`. | ||
| kind of order :math:`n`. _Note that this is in contrast to a common convention | ||
| that includes a minus sign in the definition._ |
There was a problem hiding this comment.
The DLMF reference seems to support the current usage, I wasn't smart enough to read the older PDF reference. I guess the negation convention is related to the singularity.
Is the _ notation doing what you intend in the rendered version?
There was a problem hiding this comment.
No, I guess I was mixing up with markdown
There was a problem hiding this comment.
Thanks @tylerjereddy. Fixed.
mdhaber
commented
Sep 22, 2024
[docs only]
lucascolley
changed the title
special.riccati_yn: highlight sign convention
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reference issue
Closes gh-12895
Closes gh-17920
What does this implement/fix?
gh-12895 requests that the sign convention for$xy_n(x)$ to $-xy_n(x)$ . Both conventions are valid, and SciPy's convention can be found in reputable references including Abramowitz and Stegun and DLMF (#12895 (comment)), so I don't think we would change it now to please some and disrupt others. This PR modifies the documentation to highlight the convention used by SciPy.
special.riccati_ynbe changed from