Move hints to their own place, with API and unicorns #3495
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
happz
added
code | style
happz
requested review from
frantisekz,
psss,
lukaszachy,
thrix,
janhavlin and
martinhoyer
as code owners
happz
force-pushed
the
hints-everywhere
branch
from
e1a399b to
7e5490e
Compare
happz
added
ci | full test
|
Adding |
happz
force-pushed
the
hints-everywhere
branch
4 times, most recently
from
a010e3b to
176d9dd
Compare
I wanted to change a couple of things about "hints" tmt shows to users when when a package is missing and functionality is limited: * Static, stored in a single function. That made them detached from their origin, and 3rd party plugins would have no chance to add their own hints. * A bit confined text of hints did not cover all possible venues. PyPI installation was ignored by some, other hints spoke just about using `pip install`. * Hints are interesting and useful, but visible only when error strikes. The patch turns the function into a "registry", a simple dictionary storing them. Plugins and tmt code in general can "register" their hints, and a nice tools are available for showing them. Hints wow have IDs, and there are dedicated IDs for step-specific (``report``, ...) and plugin-specific (``report/foo``) hints, allowing tmt core to print them when step or plugins crashes on import. Plugin-specific hints are now rendered both in their CLI and HTML documentation. In the future, I would like to provide hints not just as "a package foo is missing, install it" guide, but also explaining various errors and issues tmt would report, e.g. pairing them with exceptions, "To learn more, run `tmt about E1234`".
happz
force-pushed
the
hints-everywhere
branch
from
176d9dd to
d54ed6d
Compare
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.
I wanted to change a couple of things about "hints" tmt shows to users when when a package is missing and functionality is limited:
pip install.The patch turns the function into a "registry", a simple dictionary storing them. Plugins and tmt code in general can "register" their hints, and a nice tools are available for showing them.
Hints wow have IDs, and there are dedicated IDs for step-specific (
report, ...) and plugin-specific (report/foo) hints, allowing tmt core to print them when step or plugins crashes on import.Plugin-specific hints are now rendered both in their CLI and HTML documentation.
In the future, I would like to provide hints not just as "a package foo is missing, install it" guide, but also explaining various errors and issues tmt would report, e.g. pairing them with exceptions, "To learn more, run
tmt about E1234".Pull Request Checklist