diff options
| author |  kwzrd <[email protected]> | 2021-03-18 01:11:59 +0100 |
|---|---|---|
| committer | kwzrd <[email protected]> | 2021-03-18 01:14:53 +0100 |
| commit | 1b3c23a7d89d64a899a67fbfd0e69e2fa3acd911 (patch) | |
| tree | a039beb798d71cb62aa943bc675b4aaa9c615d18 | |
| parent | Branding: extend command aliases (diff) | |
Branding: update 'synchronise' docs
After previous changes, the docstring was no longer accurate.
See: 1d5625a2f47a1d4d050f9eb0eb7a18e7d6fe171b
| -rw-r--r-- | bot/exts/backend/branding/_cog.py | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/bot/exts/backend/branding/_cog.py b/bot/exts/backend/branding/_cog.py index 57b762d1f..0723458c2 100644 --- a/bot/exts/backend/branding/_cog.py +++ b/bot/exts/backend/branding/_cog.py @@ -341,9 +341,9 @@ class Branding(commands.Cog): """ Fetch the current event and delegate to `enter_event`. - This is a convenience wrapper to force synchronisation either via a command, or when the daemon starts - with an empty cache. It is generally only used in a recovery scenario. In the usual case, the daemon - already has an `Event` instance and can pass it to `enter_event` directly. + This is a convenience function to force synchronisation via a command. It should generally only be used + in a recovery scenario. In the usual case, the daemon already has an `Event` instance and can pass it + to `enter_event` directly. Returns a 2-tuple indicating whether the banner, and the icon, were applied successfully. """ |