Fix docstring inconsistencies: string -> str, boolean -> bool #82410
Conversation
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
🔗 Helpful links
✅ No Failures (0 Pending)As of commit baff973 (more details on the Dr. CI page): Expand to see more💚 💚 Looks good so far! There are no failures yet. 💚 💚 This comment was automatically generated by Dr. CI (expand for details).Please report bugs/suggestions to the (internal) Dr. CI Users group. |
jbschlosser
reviewed
Jul 28, 2022
…merGov/pytorch into doc-standard-unification-2
…merGov/pytorch into doc-standard-unification-2
…merGov/pytorch into doc-standard-unification-2
ProGamerGov
requested review from
H-Huang,
awgu,
mingzhe09088,
mrshenli,
pritamdamania87,
rohan-varma and
zhaojuanmao
as code owners
|
@jbschlosser I found another similar inconsistency with |
ProGamerGov
changed the title
|
@pytorchbot merge |
|
@pytorchbot successfully started a merge job. Check the current status here |
|
Hey @ProGamerGov. |
pytorchmergebot
pushed a commit
that referenced
this pull request
Jul 29, 2022
### Description * Docstrings using `(tuple of ints)` shows up as `(tuple of python:ints)`, so I fixed them by making the `int` no longer plural. Example: https://pytorch.org/docs/stable/generated/torch.permute.html#torch.permute * A docstring type in JIT had one of its types incorrectly highlighted as code. Example: https://pytorch.org/docs/stable/generated/torch.jit.script.html#torch.jit.script * I found some docstring type usages of `string` that had not yet been converted to `str` after #82410 * Some docstrings incorrectly listed their defaults inside the docstring types. * I also found a docstring that was missing its type ### Testing No testing should be required. --- In the developer guidelines, there should probably be standards listed for the docstring types. Pull Request resolved: #82474 Approved by: https://github.com/albanD
facebook-github-bot
pushed a commit
that referenced
this pull request
Aug 1, 2022
#82410) Summary: ### Description Throughout the PyTorch docs and codebase, the `string` type in docstrings is referred to by two separate names. This leads to inconsistent docs, like you can see here: https://pytorch.org/docs/stable/generated/torch.nn.Conv3d.html#torch.nn.Conv3d This PR fixes this issue by ensuring that all mentions of the string type in docstrings, are using the same format that Sphinx generates hyperlinks for. ### Testing No testing should be required for this change Pull Request resolved: #82410 Approved by: https://github.com/jbschlosser Test Plan: contbuild & OSS CI, see https://hud.pytorch.org/commit/pytorch/pytorch/357b7d589c9c451f4850449b9313d8b857ae7140 Reviewed By: osalpekar Differential Revision: D38290577 Pulled By: osalpekar fbshipit-source-id: d0308018d29e99a14ec1858e5a123fe85109c08f
facebook-github-bot
pushed a commit
that referenced
this pull request
Aug 1, 2022
Summary: ### Description * Docstrings using `(tuple of ints)` shows up as `(tuple of python:ints)`, so I fixed them by making the `int` no longer plural. Example: https://pytorch.org/docs/stable/generated/torch.permute.html#torch.permute * A docstring type in JIT had one of its types incorrectly highlighted as code. Example: https://pytorch.org/docs/stable/generated/torch.jit.script.html#torch.jit.script * I found some docstring type usages of `string` that had not yet been converted to `str` after #82410 * Some docstrings incorrectly listed their defaults inside the docstring types. * I also found a docstring that was missing its type ### Testing No testing should be required. Test Plan: contbuild & OSS CI, see https://hud.pytorch.org/commit/pytorch/pytorch/8def154e00f55dd4f7fd4bff20ee50309eaf3132 Reviewed By: osalpekar Differential Revision: D38306839 fbshipit-source-id: 0a46f53b78414a05d593ef869ad9b3d2a1f40e37
albanD
added
topic: docs
pytorchmergebot
pushed a commit
that referenced
this pull request
Aug 17, 2022
This PR builds on the following past PRs, and serves to help improve the consistency of PyTorch's docstring formatting. * `boolean` -> `bool` and `string` -> `str`: #82410 * Don't use plural of types: #82474 * Capitalize the Callable type, `callable` -> `Callable` : #82487 Pull Request resolved: #83536 Approved by: https://github.com/H-Huang, https://github.com/albanD
facebook-github-bot
pushed a commit
that referenced
this pull request
Aug 17, 2022
#83536) Summary: This PR builds on the following past PRs, and serves to help improve the consistency of PyTorch's docstring formatting. * `boolean` -> `bool` and `string` -> `str`: #82410 * Don't use plural of types: #82474 * Capitalize the Callable type, `callable` -> `Callable` : #82487 Pull Request resolved: #83536 Approved by: https://github.com/H-Huang, https://github.com/albanD Test Plan: contbuild & OSS CI, see https://hud.pytorch.org/commit/pytorch/pytorch/dcda907693e9e7661c099c3b9ed25fadaed273f8 Reviewed By: seemethere Differential Revision: D38788502 fbshipit-source-id: dd03fe64694385a583c21c4f0e0198d671fd4dd6
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
Description
Throughout the PyTorch docs and codebase, the
stringtype in docstrings is referred to by two separate names. This leads to inconsistent docs, like you can see here: https://pytorch.org/docs/stable/generated/torch.nn.Conv3d.html#torch.nn.Conv3dThis PR fixes this issue by ensuring that all mentions of the string type in docstrings, are using the same format that Sphinx generates hyperlinks for.
Testing
No testing should be required for this change