-
Notifications
You must be signed in to change notification settings - Fork 5.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
translate api standard #9521
translate api standard #9521
Conversation
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Abnormity -> abnormality
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
defualt -> default
Done |
fix #9518