Skip to content
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

Jump to bottom

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

Merged
merged 4 commits into from
Nov 16, 2023
Merged

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

merged 4 commits into from
Nov 16, 2023

Conversation

dgw
Copy link
Member

@dgw dgw commented Nov 9, 2023

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

  • I have read CONTRIBUTING.md
  • I can and do license this contribution under the EFLv2
  • No issues are reported by make qa (runs make lint and make test)
    • Didn't run these, as I'm not touching code.
  • I have tested the functionality of the things this change touches
    • Many iterations of reviewing the rendered docs…

@dgw dgw added this to the 8.0.0 milestone Nov 9, 2023
@dgw dgw requested a review from a team November 9, 2023 21:08
SnoopJ
SnoopJ approved these changes Nov 10, 2023
View reviewed changes
Copy link
Contributor

@SnoopJ SnoopJ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I especially like the definition of extlinks! 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.

docs/source/configuration.rst Outdated Show resolved Hide resolved
sopel/bot.py Show resolved Hide resolved
sopel/config/core_section.py Show resolved Hide resolved
sopel/config/core_section.py Show resolved Hide resolved
@dgw
Copy link
Member Author

dgw commented Nov 10, 2023

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
Copy link
Contributor

SnoopJ commented Nov 10, 2023

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!

@dgw dgw added the Bugfix Generally, PRs that reference (and fix) one or more issue(s) label Nov 10, 2023
@dgw dgw changed the title docs: improve "Ignoring Users" section & x-ref unblockable/*_blocks coretasks, docs: fix auto-saving .blocks add host; improve "Ignoring Users" docs & x-refs Nov 10, 2023
@dgw
docs: improve "Ignoring Users" section & x-ref unblockable/*_blocks
0b49350 
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 deletion.
@dgw
coretasks: fix missing auto-save in .blocks add host
b8bec6a
@dgw
coretasks: better interactive help for .blocks command
a30aad5 
Eliminated the link (to a webpage we're probably going to delete) in
favor of directly specifying the available arguments, and added an
example of how to `del` a block. (The only examples before were `add`.)
Exirel
Exirel approved these changes Nov 11, 2023
View reviewed changes
Copy link
Contributor

@Exirel Exirel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright, @SnoopJ already did a review of this, and I've nothing to add. Ship it!

@dgw dgw merged commit 72493dc into master Nov 16, 2023
15 checks passed
@dgw dgw deleted the docs/improve-blocks branch November 16, 2023 21:07
@dgw dgw mentioned this pull request Nov 17, 2023
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SnoopJ SnoopJ SnoopJ approved these changes

@Exirel Exirel Exirel approved these changes

Assignees
No one assigned
Labels
Bugfix Generally, PRs that reference (and fix) one or more issue(s) Documentation
Projects
None yet
Milestone
8.0.0
Development

Successfully merging this pull request may close these issues.
3 participants
@dgw @SnoopJ @Exirel