Regenerate docs

docs/cog_guides/core.rst

@@ -9,10 +9,6 @@ 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 core
-
 .. _core-usage:
 
 -----
@@ -1150,6 +1146,14 @@ This allows the help command to show existing commands aliases if there is any.
 This defaults to True.
 Using this without a setting will toggle.
 
+Examples:
+    - ``[p]helpset showaliases False`` - Disables showing aliases on this server.
+    - ``[p]helpset showaliases`` - Toggles the value.
+
+**Arguments:**
+
+- ``[show_aliases]`` Whether to include aliases in help. Leave blank to toggle.
+
 .. _core-command-helpset-showhidden:
 
 """"""""""""""""""
@@ -1170,12 +1174,12 @@ This defaults to False.
 Using this without a setting will toggle.
 
 Examples:
-    - ``[p]helpset showhidden False`` - Disables embeds on this server.
+    - ``[p]helpset showhidden True`` - Enables showing hidden commands.
     - ``[p]helpset showhidden`` - Toggles the value.
 
 **Arguments:**
 
-- ``[show_hidden]`` Whether to use embeds on this server. Leave blank to toggle.
+- ``[show_hidden]`` Whether to use show hidden commands in help. Leave blank to toggle.
 
 .. _core-command-helpset-showsettings:
 
@@ -1240,18 +1244,18 @@ helpset usemenus
 Allows the help command to be sent as a paginated menu instead of separate
 messages.
 
-When enabled, ``[p]help`` will only show one page at a time and use reactions to navigate to other pages.
+When enabled, ``[p]help`` will only show one page at a time and will use reactions to navigate between pages.
 
 This defaults to False.
 Using this without a setting will toggle.
 
  Examples:
-    - ``[p]helpset usemenues False`` - Disables using menus on this server.
+    - ``[p]helpset usemenues True`` - Enables using menus.
     - ``[p]helpset usemenues`` - Toggles the value.
 
 **Arguments:**
 
-- ``[use_menus]`` Whether to use menus on this server. Leave blank to toggle.
+- ``[use_menus]`` Whether to use menus. Leave blank to toggle.
 
 .. _core-command-helpset-usetick:
 
@@ -1267,7 +1271,9 @@ helpset usetick
 
 **Description**
 
-This allows the help command message to be ticked if help is sent in a DM.
+This allows the help command message to be ticked if help is sent to a DM.
+
+Ticking is reacting to the help message with a ✅.
 
 Defaults to False.
 Using this without a setting will toggle.
@@ -1276,12 +1282,12 @@ Using this without a setting will toggle.
 
 
 Examples:
-    - ``[p]helpset usetick False`` - Disables ticking in DMs.
+    - ``[p]helpset usetick False`` - Disables ticking when help is sent to DMs.
     - ``[p]helpset usetick`` - Toggles the value.
 
 **Arguments:**
 
-- ``[use_tick]`` Whether to tick the help command in DMs. Leave blank to toggle.
+- ``[use_tick]`` Whether to tick the help command when help is sent to DMs. Leave blank to toggle.
 
 .. _core-command-helpset-verifychecks:
 
@@ -1326,7 +1332,7 @@ helpset verifyexists
 
 This allows the bot to respond indicating the existence of a specific help topic even if the user can't use it.
 
-.. Note:: This setting on it's own does not fully prevent command enumeration.
+.. Note:: This setting on its own does not fully prevent command enumeration.
 
 
 Defaults to False.
@@ -1455,7 +1461,7 @@ info
 
 Shows info about Red.
 
-See ``[p]custominfo`` to customize.
+See ``[p]set custominfo`` to customize.
 
 .. _core-command-invite:
 
@@ -1663,10 +1669,11 @@ Adds a user or role to the server allowlist.
 Examples:
     - ``[p]localallowlist add @26 @Will`` - Adds two users to the local allowlist
     - ``[p]localallowlist add 262626262626262626`` - Adds a user by ID
+    - ``[p]localallowlist add "Super Admins" - Adds a role with a space in the name without mentioning
 
 **Arguments:**
 
-- ``<users...>`` The user or users to remove from the local allowlist.
+- ``<users_or_roles...>`` The users or roles to remove from the local allowlist.
 
 .. _core-command-localallowlist-clear:
 
@@ -1684,7 +1691,7 @@ localallowlist clear
 
 Clears the allowlist.
 
-This disables the local allowlist.
+This disables the local allowlist and clears all entires.
 
 Example:
     - ``[p]localallowlist clear``
@@ -1729,10 +1736,11 @@ The local allowlist will be disabled if all users are removed.
 Examples:
     - ``[p]localallowlist remove @26 @Will`` - Removes two users from the local allowlist
     - ``[p]localallowlist remove 262626262626262626`` - Removes a user by ID
+    - ``[p]localallowlist remove "Super Admins" - Removes a role with a space in the name without mentioning
 
 **Arguments:**
 
-- ``<users...>`` The user or users to remove from the local allowlist.
+- ``<users_or_roles...>`` The users or roles to remove from the local allowlist.
 
 .. _core-command-localblocklist:
 
@@ -1773,12 +1781,13 @@ localblocklist add
 Adds a user or role to the local blocklist.
 
 Examples:
-    - ``[p]blocklist add @26 @Will`` - Adds two users to the local blocklist
-    - ``[p]blocklist add 262626262626262626`` - Adds a user by ID
+    - ``[p]localblocklist add @26 @Will`` - Adds two users to the local blocklist
+    - ``[p]localblocklist add 262626262626262626`` - Blocks a user by ID
+    - ``[p]localblocklist add "Bad Apples" - Blocks a role with a space in the name without mentioning
 
 **Arguments:**
 
-- ``<users...>`` The user or users to add to the local blocklist.
+- ``<users_or_roles...>`` The users or roles to add to the local blocklist.
 
 .. _core-command-localblocklist-clear:
 
@@ -1796,6 +1805,8 @@ localblocklist clear
 
 Clears the server blocklist.
 
+This disabled the server blocklist and clears all entries.
+
 Example:
     - ``[p]blocklist clear``
 
@@ -1813,7 +1824,7 @@ localblocklist list
 
 **Description**
 
-Lists users and roles on the blocklist.
+Lists users and roles on the server blocklist.
 
 Example:
     - ``[p]localblocklist list``
@@ -1836,11 +1847,12 @@ Removes user or role from blocklist.
 
 Examples:
     - ``[p]localblocklist remove @26 @Will`` - Removes two users from the local blocklist
-    - ``[p]localblocklist remove 262626262626262626`` - Removes a user by ID
+    - ``[p]localblocklist remove 262626262626262626`` - Unblocks a user by ID
+    - ``[p]localblocklist remove "Bad Apples" - Unblocks a role with a space in the name without mentioning
 
 **Arguments:**
 
-- ``<users...>`` The user or users to remove from the local blocklist.
+- ``<users_or_roles...>`` The users or roles to remove from the local blocklist.
 
 .. _core-command-mydata:
 
@@ -1876,7 +1888,7 @@ mydata 3rdparty
 
 View the End User Data statements of each 3rd-party module.
 
-This will send an attachment with the End User Data statements of all loaded 3rd party cog.
+This will send an attachment with the End User Data statements of all loaded 3rd party cogs.
 
 .. _core-command-mydata-forgetme:
 
@@ -2113,7 +2125,7 @@ Examples:
 
 **Arguments:**
 
-- ``<cogs...>`` The cog packages to unload.
+- ``<cogs...>`` The cog packages to reload.
 
 .. _core-command-restart:
 
@@ -2263,7 +2275,7 @@ This setting will be asked for by some 3rd party cogs and some core cogs.
 To add the keys provide the service name and the tokens as a comma separated
 list of key,values as described by the cog requesting this command.
 
-.. Note:: API tokens are sensitive and should only be used in a private channel or in DM with the bot.
+.. Note:: API tokens are sensitive, so this command should only be used in a private channel or in DM with the bot.
 
 
 Examples:
@@ -2513,6 +2525,7 @@ set description
 **Description**
 
 Sets the bot's description.
+
 Use without a description to reset.
 This is shown in a few locations, including the help menu.
 
@@ -2526,7 +2539,7 @@ Examples:
 
 **Arguments:**
 
-- ``[time]`` The seconds to wait before deleting the command message. Use -1 to disable.
+- ``[description]`` The description to use for this bot. Leave blank to reset to the default.
 
 .. _core-command-set-fuzzy:
 
@@ -3278,7 +3291,7 @@ Examples:
 
 **Arguments:**
 
-- ``[public]`` Whether to send traceback to the current context. Leave blank to send to DMs.
+- ``[public]`` Whether to send the traceback to the current context. Leave blank to send to your DMs.
 
 .. _core-command-unignore: