Update peak_splitting.py docs #269
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
|
Hi Joey, thanks, I also started to add some docstring here JoranAngevaare#16 but this looks good. I'll merge my comments to this PR if that is okay? |
|
Yep! Sorry for duplication |
This was referenced Jun 2, 2020
|
If @jhowl01 merges JosephJHowlett#1, our additions would be merged. |
update docstrings some more, avoid two split_peaks functions
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.
Motivated by Jelle's straxferno course, I just edited what I think was a tiny typo in the NaturalBreaksSplitter docstring. For fun I added a little PeakSplitter docstring too, then saw that @jorana signed up for that one so I put him to review so he can edit it as he likes :)
Edit: I'm not allowed to request a review heheh, but I @'ed him so that should do the trick.