Skip to content

Commit e7f788a

Browse files
authored
docs(readme): update timeout cog docs
1 parent 4202f60 commit e7f788a

1 file changed

Lines changed: 13 additions & 3 deletions

File tree

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -472,11 +472,21 @@ This cog exposes a HTTP endpoint for exporting guild metrics in Prometheus forma
472472

473473
### Timeout
474474

475+
> [!NOTE]
476+
> Timeout in this case does not refer to Discord's timeout feature.
477+
> This cog manages a moderation feature in the Homelab Discord server that was named timeout before Discord introduced their own timeout feature.
478+
475479
Manage the timeout status of users.
476480

477-
Run the command to add a user to timeout, run it again to remove them. Append a reason if you wish: `[p]timeout @someUser said a bad thing`
478-
If the user is not in timeout, they are added. If they are in timeout, they are removed.
479-
All of the member's roles will be stripped when they are added to timeout, and re-added when they are removed.
481+
Run the command to add a user to timeout, run it again to remove them.
482+
Append a reason if you wish: `[p]timeout @someUser said a bad thing`
483+
484+
- If the user is not in timeout, they are added.
485+
- If they are in timeout, they are removed.
486+
- All of the member's roles will be stripped when they are added to timeout, and re-added when they are removed.
487+
- Additionally, the member will be disconnected from any voice channels they were connected to.
488+
489+
#### Commands
480490

481491
- `[p]timeout <user> [reason]` - Add/remove a user from timeout, optionally specifying a reason.
482492
- `[p]timeoutset list` - Print the current configuration.

0 commit comments

Comments
 (0)