Updated the docstrings for utils #207
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
aronsho
reviewed
Feb 25, 2025
There was a problem hiding this comment.
Pretty nice! Only noticed two things:
- The examples sometimes don't include the import statement, I think it would be best to have it always
- In the init file, there were the many #noqa 's, maybe instead we put just one statement in the beginning? Anyway, I'm not sure what's the best practice here
If you worked on these two, feel free to merge :)
|
I included the suggestions and will merge the branch. |
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.
I updated the docstrings for the utils folder :) Let me know if you think there should be further examples/explanations!