Skip to content

[*.py] Rename "Arguments:" to "Args:" #1110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

SamuelMarks
Copy link
Contributor

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: and Arguments: in its docstrings. It is easy enough to extend my parsers to support both variants, however it looks like Arguments: is wrong anyway, as per:

Therefore, only Args: is valid. This PR replaces them throughout the codebase.

PS: For related PRs, see pytorch/pytorch/pull/49736

@codecov
Copy link

codecov bot commented Dec 22, 2020

Codecov Report

Merging #1110 (6998654) into master (479d58f) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1110   +/-   ##
=======================================
  Coverage   77.54%   77.54%           
=======================================
  Files          45       45           
  Lines        3086     3086           
=======================================
  Hits         2393     2393           
  Misses        693      693           
Impacted Files Coverage Δ
torchtext/data/dataset.py 93.82% <ø> (ø)
torchtext/data/field.py 92.83% <ø> (ø)
torchtext/data/functional.py 89.47% <ø> (ø)
torchtext/data/iterator.py 62.66% <ø> (ø)
torchtext/data/metrics.py 100.00% <ø> (ø)
torchtext/data/pipeline.py 100.00% <ø> (ø)
torchtext/data/utils.py 71.92% <ø> (ø)
torchtext/datasets/imdb.py 48.38% <ø> (ø)
torchtext/datasets/language_modeling.py 90.38% <ø> (ø)
torchtext/datasets/nli.py 49.29% <ø> (ø)
... and 20 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 479d58f...6998654. Read the comment docs.

Copy link
Contributor

@zhangguanheng66 zhangguanheng66 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's wait and see progress of the PR in pytorch core library.

Copy link
Contributor

@zhangguanheng66 zhangguanheng66 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A similar PR to pytorch has been merged. Ready to go.

@zhangguanheng66 zhangguanheng66 merged commit adc489b into pytorch:master Dec 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants