mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 03:08:55 -05:00
6acdcdeae9
* Move bankset and modlogset to core commands * Move prune over too * Finish moving prune * Move [p]economyset registeramount to [p]bankset registeramount * style fix * Fix circular import issue with another breaking change * Apparently I missed a conflict and git still let me commit... * Really git? * Rename RawUserIds -> RawUserIdConverter, improve documentation * Improve documentation of `is_owner_if_bank_global()` * MENTION_REGEX -> USER_MENTION_REGEX * Add 'bank.' prefix * Fix command examples in docstrings * Missing docstring change from `bankset prune` * Missing changes for commands in modlogset * Update docs * Remove duplicated info in `economyset showsettings` * Fix toctree in index.rst * Add command group prefixes to names of functions for bankset/modlogset * Remaining string updates due to command name changes * Ensure that the bank folder is actually gone Co-authored-by: palmtree5 <palmtree5+3577255@users.noreply.github.com> Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
116 lines
1.5 KiB
ReStructuredText
116 lines
1.5 KiB
ReStructuredText
.. _modlog:
|
|
|
|
======
|
|
ModLog
|
|
======
|
|
|
|
This is the cog guide for the modlog cog. You will
|
|
find detailed docs about usage and commands.
|
|
|
|
``[p]`` is considered as your prefix.
|
|
|
|
.. note:: To use this cog, load it by typing this::
|
|
|
|
[p]load modlog
|
|
|
|
.. _modlog-usage:
|
|
|
|
-----
|
|
Usage
|
|
-----
|
|
|
|
Browse and manage modlog cases.
|
|
|
|
|
|
.. _modlog-commands:
|
|
|
|
--------
|
|
Commands
|
|
--------
|
|
|
|
.. _modlog-command-case:
|
|
|
|
^^^^
|
|
case
|
|
^^^^
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]case <number>
|
|
|
|
**Description**
|
|
|
|
Show the specified case.
|
|
|
|
**Arguments**
|
|
|
|
* ``<case>``: The case number to get information for.
|
|
|
|
.. _modlog-command-casesfor:
|
|
|
|
^^^^^^^^
|
|
casesfor
|
|
^^^^^^^^
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]casesfor <member>
|
|
|
|
**Description**
|
|
|
|
Display cases for the specified member.
|
|
|
|
**Arguments**
|
|
|
|
* ``<member>``: The member to get cases for. |member-input|
|
|
|
|
.. _modlog-command-listcases:
|
|
|
|
^^^^^^^^^
|
|
listcases
|
|
^^^^^^^^^
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]listcases <member>
|
|
|
|
**Description**
|
|
|
|
List cases for the specified member.
|
|
|
|
**Arguments**
|
|
|
|
* ``<member>``: The member to get cases for. |member-input|
|
|
|
|
.. _modlog-command-reason:
|
|
|
|
^^^^^^
|
|
reason
|
|
^^^^^^
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]reason [case] <reason>
|
|
|
|
**Description**
|
|
|
|
Specify a reason for a modlog case.
|
|
|
|
Please note that you can only edit cases you are
|
|
the owner of unless you are a mod, admin or server owner.
|
|
|
|
**Arguments**
|
|
|
|
* ``[case]``: The case number to update the reason for.
|
|
* ``<reason>``: The new reason for the specified case.
|
|
|
|
.. note:: If no case number is specified, the latest case will be used.
|