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.

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

coretasks: fix/improve .blocks help output #2345

Merged
merged 1 commit into from
Aug 31, 2022
Merged

coretasks: fix/improve .blocks help output #2345

merged 1 commit into from
Aug 31, 2022

Conversation

dgw
Copy link
Member

@dgw dgw commented Aug 24, 2022

Description

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.

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 quality and make test)
  • I have tested the functionality of the things this change touches

Example

New output of .help blocks on my test bot, using the new sopel-help package:

image

Notes

Yes, I'm jumping the gun a bit on #2344 by using "host" instead of "hostmask" here, but this stuff is so simple that it's just not worth messing with stacked PRs, rebasing, etc. 😁

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.
@dgw dgw added this to the 8.0.0 milestone Aug 24, 2022
@dgw dgw requested a review from a team August 24, 2022 05:04
@dgw dgw merged commit 9738515 into master Aug 31, 2022
@dgw dgw deleted the blocks-docstring branch August 31, 2022 00:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants