Updated docstrings using darglint #2827
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
…d lines into multiple where they were overflowing
# Conflicts: # gym/envs/mujoco/mujoco_env.py
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.
Following the docstring PRs # that added
pydocstyleThis tool successfully helps ensure that all appropriate functions have docstrings
However,
pydocstyledoes not actual check the content of the functions are correctIn this PR, I have used darglint that does check the content against the docstring
We have used this to update all docstrings that are missing, in particular exceptions.
I noticed that due to using
logging.warnthatdarglintmisses and so functions are generally missing their warning section