Enhanced peak_search documentation
#3582
Merged
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
This PR clarifiy the returned type of peak indices (`float`, not `int` as one can expect for indices). closes #3579
|
No time to provide feedback... I would have said |
|
From the look at the code I had, even if it is floats, values are always integers so there is no need to take care of rounding. |
|
It is for the case we decide to return the weighted average of three channels. Now it is correct. |
|
OK, then we can update the documentation when this is changed. |
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.
This PR clarifiy the returned type of peak indices (
float, notintas one can expect for indices).closes #3579