Convert general submodule docstrings to numpydoc #53
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
willGraham01
approved these changes
Mar 15, 2024
| Returns True if a number is even | ||
| :param num: | ||
| :return: | ||
| Returns True if a number is even. |
There was a problem hiding this comment.
Suggested change
| Returns True if a number is even. | |
| Returns True if the non-zero input number is even. |
I have no idea why we throw an error if the input is zero (since 0 is a perfectly fine even number) but I presume that this function will be used further up the dependency chain in which this case might be important?
Either way, it probably needs a Raises section added too if we're being docstring-precise.
There was a problem hiding this comment.
That is weird - not sure why this is needed! I added your suggestion + a Raises section to indicate zero isn't accepted
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.
Description
What is this PR
Why is this PR needed?
Docstrings in the
generalsub-module are currently in reST style.What does this PR do?
Converts all docstrings in the
generalsub-module to numpdoc style.References
For #19
How has this PR been tested?
All tests run locally.
Is this a breaking change?
No.
Does this PR require an update to the documentation?
No - docstrings have been updated.
Checklist: