Add must_use to std docs (Kampfkarren#583)

Closes: Kampfkarren#407 Adds `must_use` functionality and documentation for std docs.
Midnightific · Feb 5, 2024 · 231ad62 · 231ad62
1 parent b803dc6
commit 231ad62
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/docs/src/usage/std.md b/docs/src/usage/std.md
@@ -78,6 +78,20 @@ Example:
       type: any
 ```
 
+#### "must_use"
+This field is used for checking if the return value of a function is used.
+
+- `false` - The default. The return value of this function does not need to be used.
+- `true` - The return value of this function must be used.
+
+Example:
+```yml
+  tostring:
+    args:
+      - type: any
+    must_use: true
+```
+
 #### Argument types
 - `"any"` - Allows any value.
 - `"bool"`, `"function"`, `"nil"`, `"number"`, `"string"`, `"table"` - Expects a value of the respective type.