Fix the return documentation rendering for all model outputs #6022
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
Codecov Report
@@ Coverage Diff @@
## master #6022 +/- ##
==========================================
+ Coverage 78.29% 78.70% +0.40%
==========================================
Files 146 146
Lines 26249 26268 +19
==========================================
+ Hits 20552 20674 +122
+ Misses 5697 5594 -103
Continue to review full report at Codecov.
|
sshleifer
approved these changes
Jul 24, 2020
| blocks = [] | ||
| current_block = "" | ||
| for line in output_args_doc.split("\n"): | ||
| # If the indent is the same as the beginning, the line is the name of new arg. |
There was a problem hiding this comment.
do you call _convert_output_args_doc anywhere?
There was a problem hiding this comment.
Just a little bit under in _prepare_output_docstrings
LysandreJik
approved these changes
Jul 27, 2020
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.
All PyTorch model outputs are documented from their output types. A problem is that just using the docstrings of the output class doesn't render properly on sphinx (this was also the case before the new model outputs were introduced).
This PR adds a function that converts the args part of the docstrings of the output class to render properly on our doc. You can see the transformation by looking here for the docs before this PR and here for after it's merged (it's one example, but it will give the same result for all models). Scroll a bit to get to the return part of the doc.