diff --git a/.github/labeler.yml b/.github/labeler.yml index c6a585559..cae3ee5ae 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -138,7 +138,10 @@ # Docs - docs/cog_permissions.rst "Category: Reports Cog": + # Source - redbot/cogs/reports/* + # Docs + - docs/cog_guides/reports.rst "Category: RPC/ZMQ API": # Source - redbot/core/rpc.py diff --git a/docs/cog_guides/reports.rst b/docs/cog_guides/reports.rst new file mode 100644 index 000000000..8a3561e27 --- /dev/null +++ b/docs/cog_guides/reports.rst @@ -0,0 +1,141 @@ +.. _reports: + +======= +Reports +======= + +This is the cog guide for the reports 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 reports + +.. _reports-usage: + +----- +Usage +----- + +Create user reports that server staff can respond to. + +Users can open reports using ``[p]report``. These are then sent +to a channel in the server for staff, and the report creator +gets a DM. Both can be used to communicate. + + +.. _reports-commands: + +-------- +Commands +-------- + +.. _reports-command-report: + +^^^^^^ +report +^^^^^^ + +**Syntax** + +.. code-block:: none + + [p]report [text] + +**Description** + +Send a report. + +Use without arguments for interactive reporting, or do +``[p]report [text]`` to use it non-interactively. + +**Arguments** + +* ``[text]``: The content included within the report. + +.. _reports-command-report-interact: + +""""""""""""""" +report interact +""""""""""""""" + +.. note:: |mod-lock| + +**Syntax** + +.. code-block:: none + + [p]report interact + +**Description** + +Open a message tunnel. + +This tunnel will forward things you say in this channel +to the ticket opener's direct messages. + +Tunnels do not persist across bot restarts. + +**Arguments** + +* ````: The ticket number to open the tunnel in. + +.. _reports-command-reportset: + +^^^^^^^^^ +reportset +^^^^^^^^^ + +.. note:: |admin-lock| + +**Syntax** + +.. code-block:: none + + [p]reportset + +**Description** + +Manage Reports. + +.. _reports-command-reportset-output: + +"""""""""""""""" +reportset output +"""""""""""""""" + +.. note:: |admin-lock| + +**Syntax** + +.. code-block:: none + + [p]reportset output + +**Description** + +Set the channel where reports will be sent. + +**Arguments** + +* ````: |channel-input| + +.. _reports-command-reportset-toggle: + +"""""""""""""""" +reportset toggle +"""""""""""""""" + +.. note:: |admin-lock| + +**Syntax** + +.. code-block:: none + + [p]reportset toggle + +**Description** + +Enable or disable reporting for this server. diff --git a/docs/index.rst b/docs/index.rst index 97e41ef76..5fe8c5d8e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -45,6 +45,7 @@ Welcome to Red - Discord Bot's documentation! cog_guides/filter cog_guides/general cog_guides/image + cog_guides/reports cog_guides/streams cog_guides/trivia red_core_data_statement diff --git a/redbot/cogs/reports/reports.py b/redbot/cogs/reports/reports.py index 422044702..eab61cf84 100644 --- a/redbot/cogs/reports/reports.py +++ b/redbot/cogs/reports/reports.py @@ -114,7 +114,7 @@ class Reports(commands.Cog): @checks.admin_or_permissions(manage_guild=True) @reportset.command(name="toggle", aliases=["toggleactive"]) async def reportset_toggle(self, ctx: commands.Context): - """Enable or Disable reporting for this server.""" + """Enable or disable reporting for this server.""" active = await self.config.guild(ctx.guild).active() active = not active await self.config.guild(ctx.guild).active.set(active)