Skip to content

Commit

Permalink
docs(readme): document allowed mentions should be strings
Browse files Browse the repository at this point in the history
  • Loading branch information
favna committed Aug 10, 2024
1 parent 3bb7ead commit 2d96b04
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,12 @@ To insert these values, use the following syntax: `${BUILD_ID}` or `$BUILD_ID`
(default: `[]`).
- `.users` (_array of strings_): Users that are allowed to be mentioned
(default: `[]`).

> [!IMPORTANT]
>
> Make sure to wrap these values in quotes to prevent YAML from interpreting
> them as numbers and performing invalid rounding operation.

- `flags` (_object_): An object of the allowed values from
[message flags](https://discord.com/developers/docs/resources/message#message-object-message-flags)
- `.suppress_embeds` (_boolean_): Do not include any embeds when serializing
Expand Down

0 comments on commit 2d96b04

Please sign in to comment.