[Docs] Fix incomplete docstring for resnet.py#3438
Merged
Conversation
|
The documentation is not available anymore as the PR was closed or merged. |
Contributor
|
Amazing! Thanks a lot for the improvements here! |
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
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.
Docstrings of some Upsampling and Downsampling layers were incomplete or missing.
I didn't know exactly what format to use for the docstrings since it doesn't seem to be specified in
CONTRIBUTING.mdOverall, the various docstrings in the project don't all seem to be very consistent (some are formatted like Google's convention, some others look like Numpy's convention). Would it be a good idea to enable pydocstyle in ruff to overcome some of these issues ?
Like so (in pyproject.toml):