calc: improve help output, test coverage (now 100%) #2530
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
Exirel
approved these changes
Oct 27, 2023
SnoopJ
approved these changes
Oct 28, 2023
Oops! All Error Cases! ...were not covered by the test suite. That was the easiest 100% ever.
Sopel displays only one example command if none of the examples is defined as `user_help=True`, and I believe these four happen to show off the most variety of usage in a suitably succinct way.
|
With apologies for the force-push, I had to rebase in order to make the wording change addressing @SnoopJ's stylistic concern over one error message. (Blame the merging of #2504.) Scout's honor that that was the only thing I changed, but this diff is small enough that you guys can definitely re-review it if you want between now and when it gets merged. |
These additional cases (and a new error handler) cover as much of the `tools.calculation` submodule as possible using the example decorator. Further coverage of `tools.calculation` would require real unit tests of the sort one finds in this project's `test/` directory.
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.
Error cases weren't covered by the
@plugin.exampletests. Fixed that.Also declared a few more examples that should appear in the help output, to showcase more of the plugin's capabilities.
Follow-up to #2503 (comment).
Checklist
make qa(runsmake lintandmake test)