Adding the rst file to render IO under Fluid in paddlepaddle.org #7470
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
luotao1
reviewed
Jan 12, 2018
There was a problem hiding this comment.
Can you paste the generated result like #7445 (comment) to help check the correct format?
doc/api/v2/fluid/io.rst
Outdated
|
|
||
|
|
||
|
|
||
| isParameter |
python/paddle/v2/fluid/io.py
Outdated
| var : The input variable. | ||
| Returns: | ||
| boolean result whether the variable is a Parameter |
There was a problem hiding this comment.
Is line 14 and line 22 lacking periods in the end?
There was a problem hiding this comment.
Thank you! I will fix these things. Just wanted to check if it renders the comment at all.
| ] | ||
|
|
||
|
|
||
| def is_parameter(var): |
There was a problem hiding this comment.
As is_parameter is not in __all__, could it show correctly on the website?
|
Here is a screesnhot after adding the rst: |
|
From the screenshot, there is no heading |
|
Ah right, that was a stale screenshot before I renamed it, here is the updated one: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
This PR solves the issue : #7335
As of now, I have added comments in just the
is_parameterfunction ofio.pyand made sure this works and renders fine, and added the required rst file.Once merged, I can add comments to other functions of the file as well in order for them to render.