Skip to content

reload: better document limitations of .reload command #2417

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dgw merged 1 commit into from
Mar 6, 2023
Merged

reload: better document limitations of .reload command #2417

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions sopel/modules/reload.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,11 @@ def _load(bot, plugin):
@plugin.require_admin
@plugin.output_prefix(PLUGIN_OUTPUT_PREFIX)
def f_reload(bot, trigger):
"""Reloads a plugin (for use by admins only)."""
"""Reload a plugin (for use by admins only)

NOTE: Designed to work with single-file plugins only, during development.
Restart the bot instead when making significant changes.
"""
name = trigger.group(2)

if not name or name == '*' or name.upper() == 'ALL THE THINGS':
Expand Down Expand Up @@ -75,7 +79,7 @@ def f_update(bot, trigger):
@plugin.require_admin
@plugin.output_prefix(PLUGIN_OUTPUT_PREFIX)
def f_load(bot, trigger):
"""Loads a plugin (for use by admins only)."""
"""Load a plugin (for use by admins only)"""
name = trigger.group(2)
if not name:
bot.reply('Load what?')
Expand Down