Add missing docstrings #1234
Merged
Add missing docstrings #1234
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
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| time range or data (see also further ). | ||
|
|
||
| In addition you can provide the following arguments: | ||
|
|
There was a problem hiding this comment.
[pep8] reported by reviewdog 🐶
W293 blank line contains whitespace
straxen/analyses/pulse_plots.py
Outdated
| :param path: Relative path where the PDF should be stored. By default | ||
| it is the directory of the notebook. | ||
| :param detector_ending: Ending of the corresponding detector. Empty | ||
| string for TPC '_nv' for neutron-veto and '_mv' muon-veto. |
There was a problem hiding this comment.
[pep8] reported by reviewdog 🐶
W291 trailing whitespace
| time range or data (see also further ). | ||
|
|
||
| In addition you can provide the following arguments: | ||
|
|
There was a problem hiding this comment.
[pep8] reported by reviewdog 🐶
W293 blank line contains whitespace
straxen/analyses/pulse_plots.py
Outdated
| :param path: Relative path where the PDF should be stored. By default | ||
| it is the directory of the notebook. | ||
| :param detector_ending: Ending of the corresponding detector. Empty | ||
| string for TPC '_nv' for neutron-veto and '_mv' muon-veto. |
There was a problem hiding this comment.
[pep8] reported by reviewdog 🐶
W291 trailing whitespace
| time range or data (see also further ). | ||
|
|
||
| In addition you can provide the following arguments: | ||
|
|
There was a problem hiding this comment.
[pep8] reported by reviewdog 🐶
W293 blank line contains whitespace
straxen/analyses/pulse_plots.py
Outdated
| :param path: Relative path where the PDF should be stored. By default | ||
| it is the directory of the notebook. | ||
| :param detector_ending: Ending of the corresponding detector. Empty | ||
| string for TPC '_nv' for neutron-veto and '_mv' muon-veto. |
There was a problem hiding this comment.
[pep8] reported by reviewdog 🐶
W291 trailing whitespace
…en into add_doc_string_pulse_plots
JYangQi00
approved these changes
Aug 15, 2023
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.
Adds missing doc-stings for some mini-analyses.