[FX] Add a bunch of docstrings #47719
Closed
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
[ghstack-poisoned]
Differential Revision: [D24875400](https://our.internmc.facebook.com/intern/diff/D24875400) [ghstack-poisoned]
Add more docs Differential Revision: [D24875400](https://our.internmc.facebook.com/intern/diff/D24875400) [ghstack-poisoned]
zdevito
approved these changes
Nov 11, 2020
There was a problem hiding this comment.
More docs are good! I think PyTorch docstrings follow the "Google" docstring format: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html . The contents in these docs are fine but really should be reformated to match that format.
💊 CI failures summary and remediationsAs of commit e9d7af5 (more details on the Dr. CI page): ✅ None of the CI failures appear to be your fault 💚
🚧 1 ongoing upstream failure:These were probably caused by upstream breakages that are not fixed yet:
This comment was automatically generated by Dr. CI (expand for details).Follow this link to opt-out of these comments for your Pull Requests.Please report bugs/suggestions on the GitHub issue tracker or post in the (internal) Dr. CI Users group. This comment has been revised 7 times. |
Add more docs Differential Revision: [D24875400](https://our.internmc.facebook.com/intern/diff/D24875400) [ghstack-poisoned]
|
@jamesr66a merged this pull request in d1351c6. |
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.
Stack from ghstack:
Add more docs
Differential Revision: D24875400