docs: specify empty docstring fields #36
Merged
benwandrew merged 8 commits intomainfrom Jul 21, 2023
Merged
Conversation
hollandjg
reviewed
Jul 18, 2023
Member
hollandjg
left a comment
hollandjg
left a comment
There was a problem hiding this comment.
Hey Ben, thanks for going through these! I'm not sure what the best description is for the arguments of the wrapper function, but I've made some suggestions which are more focused on the properties of the argument. Do those also make sense for you?
benwandrew
changed the title
Co-authored-by: John Gerrard Holland <john_holland1@brown.edu>
Co-authored-by: John Gerrard Holland <john_holland1@brown.edu>
Contributor
Author
yep, those are both more on the mark. thank you! |
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.
Description
add descriptions to empty fields in docstring where appropriate
Type of change