Make it clear how to install the plugin #2993
Open
+30
−23
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
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.
jwbth
changed the title
Use dash for unordered lists
Fix unordered list indentation
ljharb
reviewed
May 16, 2024
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.
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.