docs: Fixed docstring indentation for documentation #37739
Closed
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
Multi-line argument descriptions were not properly indented, which yielded a wrong parameter listing in documentation
ngimel
approved these changes
May 5, 2020
There was a problem hiding this comment.
@ngimel has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.
ShawnZhong
pushed a commit
to ShawnZhong/pytorch
that referenced
this pull request
May 5, 2020
Summary: Hello there, I was going through the default initialization of some layers, and ended up on the `torch.nn.init` documentation. As shown below, there was a slight issue with the docstrings of both `kaiming_normal_` and `kaiming_uniform_` that yielded a wrong list of function parameters:  This PR fixes the indentation in the corresponding docstrings. Any feedback is welcome! Pull Request resolved: pytorch#37739 Differential Revision: D21393728 Pulled By: ngimel fbshipit-source-id: 64523cb328e72d2e51c2c42b20a4545c1ec5f478
bharatr21
pushed a commit
to bharatr21/pytorch
that referenced
this pull request
May 5, 2020
Summary: Hello there, I was going through the default initialization of some layers, and ended up on the `torch.nn.init` documentation. As shown below, there was a slight issue with the docstrings of both `kaiming_normal_` and `kaiming_uniform_` that yielded a wrong list of function parameters:  This PR fixes the indentation in the corresponding docstrings. Any feedback is welcome! Pull Request resolved: pytorch#37739 Differential Revision: D21393728 Pulled By: ngimel fbshipit-source-id: 64523cb328e72d2e51c2c42b20a4545c1ec5f478
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.
Hello there,
I was going through the default initialization of some layers, and ended up on the
torch.nn.initdocumentation. As shown below, there was a slight issue with the docstrings of bothkaiming_normal_andkaiming_uniform_that yielded a wrong list of function parameters:This PR fixes the indentation in the corresponding docstrings.
Any feedback is welcome!