From b4186d6724b34414715edf6893c53f035f048bd9 Mon Sep 17 00:00:00 2001 From: Flame442 <34169552+Flame442@users.noreply.github.com> Date: Sat, 7 Dec 2019 19:24:07 -0500 Subject: [PATCH] Clarifies what `[p]backup` does (#3172) * Clarify `[p]backup` * Create 3172.enhance.rst --- changelog.d/3172.enhance.rst | 1 + redbot/core/core_commands.py | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) create mode 100644 changelog.d/3172.enhance.rst diff --git a/changelog.d/3172.enhance.rst b/changelog.d/3172.enhance.rst new file mode 100644 index 000000000..8838abbed --- /dev/null +++ b/changelog.d/3172.enhance.rst @@ -0,0 +1 @@ +Clarified that ``[p]backup`` saves the **bot's** data in the help text. diff --git a/redbot/core/core_commands.py b/redbot/core/core_commands.py index f0362b230..763a9391a 100644 --- a/redbot/core/core_commands.py +++ b/redbot/core/core_commands.py @@ -1323,8 +1323,9 @@ class Core(commands.Cog, CoreLogic): @commands.command() @checks.is_owner() async def backup(self, ctx: commands.Context, *, backup_dir: str = None): - """Creates a backup of all data for the instance. + """Creates a backup of all data for this bot instance. + This backs up the bot's data and settings. You may provide a path to a directory for the backup archive to be placed in. If the directory does not exist, the bot will attempt to create it.