-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
Make it clear how to install the plugin #2993
base: main
Are you sure you want to change the base?
Conversation
The markup was misleading, as it put several alternatives into one block of code while not making it clear where the alternatives begin and end, forcing the reader to think hard about it.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2993 +/- ##
==========================================
- Coverage 95.66% 95.60% -0.07%
==========================================
Files 78 78
Lines 3275 3275
Branches 1150 1150
==========================================
- Hits 3133 3131 -2
- Misses 142 144 +2 ☔ View full report in Codecov by Sentry. |
It makes it more clear that this is a list of alternatives, not a list of steps.
Use dash for unordered lists
Fix unordered list indentation
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.
Thanks! Let's convert these to json instead of yaml, while we're at it.
The markup in README.md is misleading, as it puts several alternatives into one block of code while not making it clear where the alternatives begin and end, forcing the reader to think hard about it. The pull request splits the block of code into three isolated ones, preceding each one with a comment and organizing them in a list.