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

Add must_use to std docs #583

Merged
merged 6 commits into from
Feb 5, 2024
Merged

Add must_use to std docs #583

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d2ad074
📃 docs(std): Add `must_use`
Midnightific Jan 24, 2024
b7c2350
📃 docs(std): Resolve default
Midnightific Jan 25, 2024
607ca21
📃 docs(std): Resolve example
Midnightific Jan 25, 2024
78b1523
📃 docs(std): Resolve hierarchy
Midnightific Jan 26, 2024
9dd838a
📃 docs(std): Resolve `tostring`
Midnightific Jan 26, 2024
1c9429f
Merge branch 'main' into docs-must_use
Midnightific Jan 26, 2024
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 docs/src/usage/std.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,24 @@ Example:
type: any
```

#### "must_use"
This field is used for checking if the return value of a function is used.

- `true` - The return value of this function must be used.
- `false` - The default. The return value of this function does not need to be used.
Midnightific marked this conversation as resolved.
Show resolved Hide resolved

Example:
```yml
table.find:
args:
- type: table
observes: read
required: true
- type: any
required: true
must_use: true # The return value of this function must be used
Midnightific marked this conversation as resolved.
Show resolved Hide resolved
```

#### Argument types
- `"any"` - Allows any value.
- `"bool"`, `"function"`, `"nil"`, `"number"`, `"string"`, `"table"` - Expects a value of the respective type.
Expand Down