From 49c0c7bfa059c477cee1f0c258a69d20358f21a3 Mon Sep 17 00:00:00 2001 From: dgw Date: Tue, 23 Aug 2022 20:44:55 -0500 Subject: [PATCH] coretasks: fix/improve `.blocks` help output Replaced the Liquid link tag with an actual URL, since the primary purpose of these docstrings is for help output on IRC. Added a couple examples, to show the syntax and also make it crystal clear that the inputs are interpreted as regex. --- sopel/coretasks.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/sopel/coretasks.py b/sopel/coretasks.py index 42e06b439a..63ba8ad3f8 100644 --- a/sopel/coretasks.py +++ b/sopel/coretasks.py @@ -1259,14 +1259,16 @@ def _get_sasl_pass_and_mech(bot): @plugin.commands('blocks') +@plugin.example(r'.blocks add host some\.malicious\.network', user_help=True) +@plugin.example(r'.blocks add nick sp(a|4)mb(o|0)t\d*', user_help=True) @plugin.thread(False) @plugin.unblockable @plugin.priority('low') @plugin.require_admin def blocks(bot, trigger): """ - Manage Sopel's blocking features.\ - See [ignore system documentation]({% link _usage/ignoring-people.md %}). + Manage Sopel's blocking features. + See https://sopel.chat/usage/ignoring-people/ for usage notes. """ STRINGS = { "success_del": "Successfully deleted block: %s",