This repository has been archived by the owner on Apr 1, 2021. It is now read-only.
[*.py] Rename "Arguments:" to "Args:" #40
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
I've written custom parsers and emitters for everything from docstrings to classes and functions. However, I recently came across an issue when I was parsing/generating from the TensorFlow—and now PyTorch—codebases: inconsistent use of
Args:andArguments:in its docstrings. It is easy enough to extend my parsers to support both variants, however it looks likeArguments:is wrong anyway, as per:https://google.github.io/styleguide/pyguide.html#doc-function-args @
ddccc0fhttps://chromium.googlesource.com/chromiumos/docs/+/master/styleguide/python.md#describing-arguments-in-docstrings @
9fc0fc0https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html @
c0ae8e3Therefore, only
Args:is valid. This PR replaces them throughout the codebase.PS: For related PRs, see pytorch/pytorch/pull/49736