help: support multiple examples #1403
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Lots of changes since I touched this last! Felt good to add tests for it, though. |
Exirel
requested changes
Mar 29, 2019
There was a problem hiding this comment.
It looks good. I didn't test it myself, but I'm so glad you were able to update and add unit-tests for that change!
As written in my comments, I'm asking for in-line comment, because I wasn't able to really understand what each line does. It sounds good, but I feel like a few words could prevent confusion.
|
@Exirel We're turning the usual back-and-forth on its head! It's my turn to push new commits for you to 👍 before I squash them into the appropriate places in the PR's history. 😁 |
Should behave the same as before for modules that don't use the new parameter to @sopel.module.example() to declare multiple help examples. Updated admin.py module as a proof of concept. Going through other modules and updating them with multiple examples is a separate project. Output is still tweakable, but I'm happy enough without worrying about splitting lines just yet.
The loader didn't *have* tests when work on supporting multiple help examples started. Rebasing was fun because of that.
Test the new `user_help` argument, making sure examples are included or excluded properly based on its value.
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Should behave the same as before for modules that don't use the new parameter to
@sopel.module.example()to declare multiple help examples.Updated
admin.pymodule as a proof of concept. Going through other modules and updating them with multiple examples is a separate project.Output is still tweakable, but I'm happy enough without worrying about splitting lines just yet.
This is WIP code I based off of #1303. Between the length of time between when I last looked at this and the present, and the fact that I had to manually rebase it on
master, I'm definitely leaving it labeled WIP until I get back to working on it (probably after 6.6.0 releases).Because this changes the module API (a new argument to
@sopel.module.example()is introduced), this will be a Sopel 7 project.