Fill in docstrings for functions in config.py and tests/utils.py #377
+88
−5
Conversation
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
tsalo
requested changes
Jan 16, 2025
Member
tsalo
left a comment
tsalo
left a comment
There was a problem hiding this comment.
The docstrings look solid, but I prefer to have the summary line on the same line as the quotes. E.g.,
"""Do something.
...
"""instead of
"""
Do something.
...
"""
Contributor
Author
|
thanks @tsalo - made the changes |
tsalo
changed the title
tsalo
approved these changes
Jan 16, 2025
Member
tsalo
left a comment
tsalo
left a comment
There was a problem hiding this comment.
LGTM! I changed the PR title to be a bit clearer about the scope of the changes.
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.
Relates to #358. I will next work on docstrings only in cubids src code.
Changes proposed in this pull request
Documentation that should be reviewed