Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: specify function return value #8115

Merged
merged 3 commits into from
Oct 21, 2022
Merged

docs: specify function return value #8115

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
896128c
fix: specify function return value
kingluo Oct 19, 2022
92e6ebe
fix PR
kingluo Oct 19, 2022
3f75b3a
fix PR
kingluo Oct 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions CODE_STYLE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,24 @@ local function check(age, name)
end
```

The function should return `<boolean>`, `err`.
Copy link
Member

@spacewander spacewander Oct 19, 2022 •
edited
Loading

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"

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kingluo any updates?

Copy link
Member

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

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.
Copy link
Contributor

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.


```lua
--No
local function check()
return "failed"
end
```

```lua
--Yes
local function check()
return false, "failed"
end
```

## Module

All require libraries must be localized:
Expand Down