frozenleaves/pytorch
1
0
Fork 0
mirror of https://github.com/pytorch/pytorch.git synced 2025-10-20 21:14:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

[*.py] Rename "Arguments:" to "Args:" (#49736)

Browse Source 
Summary:
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 codebase: inconsistent use of `Args:` and `Arguments:` in its docstrings.

```sh
(pytorch#c348fae)$ for name in 'Args:' 'Arguments:'; do
    printf '%-10s %04d\n' "$name" "$(rg -IFtpy --count-matches "$name" | paste -s -d+ -- | bc)"; done
Args:      1095
Arguments: 0336
```

It is easy enough to extend my parsers to support both variants, however it looks like `Arguments:` is wrong anyway, as per:

  - https://google.github.io/styleguide/pyguide.html#doc-function-args @ [`ddccc0f`](https://github.com/google/styleguide/blob/ddccc0f/pyguide.md)

  - https://chromium.googlesource.com/chromiumos/docs/+/master/styleguide/python.md#describing-arguments-in-docstrings @ [`9fc0fc0`](https://chromium.googlesource.com/chromiumos/docs/+/9fc0fc0/styleguide/python.md)

  - https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html @ [`c0ae8e3`](https://github.com/sphinx-contrib/napoleon/blob/c0ae8e3/docs/source/example_google.rst)

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

PS: For related PRs, see tensorflow/tensorflow/pull/45420

PPS: The trackbacks automatically appearing below are sending the same changes to other repositories in the [PyTorch](https://github.com/pytorch) organisation.

Pull Request resolved: https://github.com/pytorch/pytorch/pull/49736

Reviewed By: albanD

Differential Revision: D25710534

Pulled By: soumith

fbshipit-source-id: 61e8ff01abb433e9f78185c2d1d0cbd7c22c1619
This commit is contained in:
Samuel Marks
2020-12-28 09:33:01 -08:00
committed by Facebook GitHub Bot
parent 9c64b9ffba
commit e6779d4357
102 changed files with 311 additions and 311 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
torch/_lowrank.py
View File

@ -37,7 +37,7 @@ def get_approximate_basis(A, # type: Tensor
.. note:: To obtain repeatable results, reset the seed for the
pseudorandom number generator
Arguments::
Args::
A (Tensor): the input tensor of size :math:`(*, m, n)`
q (int): the dimension of subspace spanned by :math:`Q`
@ -103,7 +103,7 @@ def svd_lowrank(A, q=6, niter=2, M=None):
will be useful for huge sparse matrices that
``torch.svd`` cannot handle.
Arguments::
Args::
A (Tensor): the input tensor of size :math:`(*, m, n)`
q (int, optional): a slightly overestimated rank of A.
@ -211,7 +211,7 @@ def pca_lowrank(A, q=None, center=True, niter=2):
.. note:: To obtain repeatable results, reset the seed for the
pseudorandom number generator
Arguments:
Args:
A (Tensor): the input tensor of size :math:`(*, m, n)`