search

sopel-irc / sopel

:robot::speech_balloon: An easy-to-use and highly extensible IRC Bot framework. Formerly Willie.
https://sopel.chat
Other
951 stars 405 forks source link

coretasks, docs: fix auto-saving `.blocks add host`; improve "Ignoring Users" docs & x-refs #2550

Closed dgw closed 7 months ago

dgw commented 8 months ago

Maybe still not perfect, but there's at least a way to find out what might make a callable "blockable" (and necessitate using unblockable to change that), and how to bypass something that you don't want to be blocked getting blocked.

We do still need proper documentation on how to use built-in commands from coretasks, but I don't particularly want to link the migrated wiki page at https://sopel.chat/usage/ignoring-people/ here.

That old stuff will continue getting folded into the Sphinx docs over time. Arguably, describing the .blocks command in configuration.rst is already enough to mark the old website page for removal as part of sopel-irc/sopel.chat#45.

Checklist

dgw commented 8 months ago

Leaving myself a note here that once this PR is merged, it would make sense to sweep up the other references in Sphinx's view to issues/PRs to use that feature.

FWIW, when adding the extlinks bit, I grepped the sopel/ and docs/ folders for any strings like github.com/sopel- and found only the issue/PR links I updated as part of this patch. Please do feel free to go check again; it's certainly possible that I missed some. But if you don't find any, you'll know why. 🙂

SnoopJ commented 8 months ago

FWIW, when adding the extlinks bit, I grepped the sopel/ and docs/ folders for any strings like github.com/sopel- and found only the issue/PR links I updated as part of this patch. Please do feel free to go check again; it's certainly possible that I missed some. But if you don't find any, you'll know why. 🙂

I did the same check and thought I saw a few, but upon review, I see that the ones that aren't part of your changeset are comments outside of Sphinx's domain anyway. Oops!