-
Notifications
You must be signed in to change notification settings - Fork 2.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
docs: specify function return value #8115
Conversation
@@ -320,6 +320,10 @@ local function check(age, name) | |||
end | |||
``` | |||
|
|||
The function should return `<boolean>`, `err`. |
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.
PR contains change in the doc should not begin with the prefix "fix"
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.
@kingluo any updates?
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.
we'd better to add some good or bad example, make it clearer
CODE_STYLE.md
Outdated
@@ -320,6 +320,24 @@ local function check(age, name) | |||
end | |||
``` | |||
|
|||
The function should return `<boolean>`, `err`. | |||
The first return value means successful or not, if not, the second return value specifies the error message. | |||
The error message can be ignore in some case. |
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.
The error message can be ignored in some case.
Description
Fixes # (issue)
Checklist