translate api standard #9521
Merged
translate api standard #9521
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
abhinavarora
suggested changes
Mar 30, 2018
doc/fluid/dev/api_doc_std_en.md
Outdated
| - Function Description | ||
|
|
||
| Description of API's function. | ||
| The discription includes: meaning, purpose and operation on input of API, reference and corresponding link(if any), formula(if necessary) and explanations of key variables in the formula. |
There was a problem hiding this comment.
discription -> description
doc/fluid/dev/api_doc_std_en.md
Outdated
|
|
||
| Introduction of API returned value. | ||
| Introduce meaning of returned value, provide corrspoding format if necessary. | ||
| If returned value is tuple containing multiple parameters, then introduce parameters one by one in order. |
There was a problem hiding this comment.
is tuple -> is a tuple
doc/fluid/dev/api_doc_std_en.md
Outdated
| - Returns | ||
|
|
||
| Introduction of API returned value. | ||
| Introduce meaning of returned value, provide corrspoding format if necessary. |
There was a problem hiding this comment.
corrspoding -> corresponding
doc/fluid/dev/api_doc_std_en.md
Outdated
|
|
||
| - Raises（if any） | ||
|
|
||
| Abnormity, error that may occur, and possible reasons. If there are more than one possible abnormity or error, they should be listed in order. |
There was a problem hiding this comment.
Abnormity -> abnormality
sidgoyal78
reviewed
Mar 30, 2018
doc/fluid/dev/api_doc_std_en.md
Outdated
|
|
||
| Description of API parameters. | ||
| Introduce parameters one by one according to the order in API definition. | ||
| The introduction includes: data type, defualt value(if any), meaning, etc. |
|
Done |
abhinavarora
approved these changes
Mar 31, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
fix #9518