mirror of
https://github.com/reality/dbot.git
synced 2024-12-25 04:02:39 +01:00
Module documentation for Report [#75]
This commit is contained in:
parent
11cfa5d40c
commit
2e1de98df9
19
modules/report/README.md
Normal file
19
modules/report/README.md
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
## Report
|
||||||
|
|
||||||
|
Report users
|
||||||
|
|
||||||
|
### Description
|
||||||
|
This module provides a command which allows users to report other users in a
|
||||||
|
channel to the operators of the channel, as well as posting an alert in the
|
||||||
|
administrative channel. It can be done either anonymously or publicly in the
|
||||||
|
channel.
|
||||||
|
|
||||||
|
### Commands
|
||||||
|
|
||||||
|
#### ~report [#channel] [username] [reason for reporting]
|
||||||
|
Report a user in a channel for a reason. This command can either be run publicly
|
||||||
|
in a channel or anonymously in a PM to the bot. The result of using this command
|
||||||
|
will be that all of the users which are currently marked as operators in the
|
||||||
|
reporting channel will receive a PM telling them a user has been reported, by
|
||||||
|
whom, in which channel and why. If there is an administrative channel for the
|
||||||
|
reporting channel (e.g. ##channel), the report will be posted there as well.
|
Loading…
Reference in New Issue
Block a user