docs: specify function return value (#8115)

apache · Oct 21, 2022 · ecdc209 · ecdc209
1 parent 3697460
commit ecdc209
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/CODE_STYLE.md b/CODE_STYLE.md
@@ -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 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: