From 4b88be289e78e2e03858b0ed11d6c65ca2d00527 Mon Sep 17 00:00:00 2001 From: dgw Date: Thu, 27 Jan 2022 07:17:32 -0600 Subject: [PATCH] docs: `plugin/anatomy` style tweaks --- docs/source/plugin/anatomy.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/source/plugin/anatomy.rst b/docs/source/plugin/anatomy.rst index 8828821f9c..b3459fab07 100644 --- a/docs/source/plugin/anatomy.rst +++ b/docs/source/plugin/anatomy.rst @@ -133,22 +133,22 @@ other users that are flagged as bots, or users who are certain cases, it might be desirable to bypass these defaults using one or more of these decorators: -* :func:`~sopel.plugin.allow_bots`: the rule will receive events from other - users flagged as bots (like Sopel itself) -* :func:`~sopel.plugin.echo`: the rule will receive Sopel's own actions (e.g. - the output of any calls to :func:`bot.say `) -* :func:`~sopel.plugin.unblockable`: the rule will ignore rate-limiting or +* :func:`sopel.plugin.allow_bots`: the rule will accept events from other + users who are flagged as bots (like Sopel itself) +* :func:`sopel.plugin.echo`: the rule will accept Sopel's own output (e.g. + from calls to :func:`bot.say() `) +* :func:`sopel.plugin.unblockable`: the rule will ignore rate-limiting or nick/host blocks and always process the event -For example, Sopel itself uses the :func:`~sopel.plugin.unblockable` decorator +For example, Sopel itself uses the :func:`sopel.plugin.unblockable` decorator to track joins/parts from everyone, always, so plugins can *always* access data about any user in any channel. .. important:: - The :func:`~sopel.plugin.echo` decorator will send *anything* Sopel says + The :func:`sopel.plugin.echo` decorator will send *anything* Sopel says (that matches the rule) to the decorated callable, *including output from - the callable itself*. Be careful not to create a feedback loop. + the decorated callable*. Be careful not to create a feedback loop. Rule labels -----------