Add docstrings to pipeline functions - #30
Merged
Merged
Conversation
Collaborator
Author
|
Hey @namurphy , should we address the |
for more information, see https://pre-commit.ci
Collaborator
Author
|
pre-commit.ci autofix |
joyvelasquez
added
pipeline: L0
Collaborator
Author
namurphy
reviewed
Sep 30, 2026
Comment on lines
+66
to
+71
|
|
||
| Notes | ||
| ----- | ||
| If the file cannot be read, this function prints the error, opens a | ||
| ``pdb`` debugging session, and then exits the program. | ||
| @namurphy - should we start to replace these ``pdb`` so we don't heavy over use ``ruff:ignore`` |
Member
There was a problem hiding this comment.
Suggested change
| Notes | |
| ----- | |
| If the file cannot be read, this function prints the error, opens a | |
| ``pdb`` debugging session, and then exits the program. | |
| @namurphy - should we start to replace these ``pdb`` so we don't heavy over use ``ruff:ignore`` |
namurphy
reviewed
Sep 30, 2026
namurphy
reviewed
Sep 30, 2026
namurphy
reviewed
Sep 30, 2026
namurphy
reviewed
Sep 30, 2026
Co-authored-by: Nick Murphy <namurphy@users.noreply.github.com>
Co-authored-by: Nick Murphy <namurphy@users.noreply.github.com>
Co-authored-by: Nick Murphy <namurphy@users.noreply.github.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 adds NumPy-style docstrings to functions in the pipeline modules that currently have none. Each function gets its own commit, so the changes are easy to review one at a time, issue #26 .