-
Notifications
You must be signed in to change notification settings - Fork 74
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
Add short plugin description to each plugin under title #3268
Add short plugin description to each plugin under title #3268
Conversation
4ba4c6d
to
3c42bf6
Compare
Looks great! |
Remove the 'docs description' if it only repeats information from the title description. In the case where new information is included, keep the description but remove the repetitive part. |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3268 +/- ##
==========================================
+ Coverage 88.76% 88.80% +0.04%
==========================================
Files 125 125
Lines 18961 19009 +48
==========================================
+ Hits 16830 16881 +51
+ Misses 2131 2128 -3 ☔ View full report in Codecov by Sentry. |
5d60967
to
fdc1ad4
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I left one minor suggestion but other than that, looks good.
just had an idea (not necessary for this PR, but it might be super simple) - could these strings be included in the logic for plugin search at the top? See |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks really great and quite excited about the search ability! (Thought for the future: we could also have a list of keywords for each plugin which aren't displayed but would still match the search).
One question: Why do some plugins set self._plugin_description
and others self.plugin_description
? Is there a benefit to going through the setter or not in the inits - and can we stick with one or the other?
I'm also going to open a small PR to your branch with some styling tweaks to tighten the padding. Feel free to take it or leave it or modify further. We can also run this by Jenn at some point for future additional styling tweaks.
tighten padding around new plugin descriptions
Adds a short one sentence description of each plugin in the side menu under the plugin title, that is visible before the plugin is opened. This PR also enables search based on text in the plugin description.