Better sinc docstring
#51858
Merged
Better sinc docstring
#51858
Conversation
This file contains 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
aviatesk
approved these changes
Oct 25, 2023
|
The CI failure is unrelated to this. |
staticfloat
pushed a commit
that referenced
this pull request
Oct 27, 2023
There are two types for the `sinc` function, unnormalized
$\frac{\sin(x)}{x}$ and normalized $\frac{\sin(\pi x)}{\pi x}$.
(https://en.wikipedia.org/wiki/Sinc_function)
This PR updates the docstring and clarify which of these definition is
used.
Related:
#36954 (comment),
#51551
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.
There are two types for the$\frac{\sin(x)}{x}$ and normalized $\frac{\sin(\pi x)}{\pi x}$ . (https://en.wikipedia.org/wiki/Sinc_function)
sincfunction, unnormalizedThis PR updates the docstring and clarify which of these definition is used.
Related: #36954 (comment), #51551