docs: consistent markdown formatting #3615
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
Codecov Report
@@ Coverage Diff @@
## develop #3615 +/- ##
===========================================
- Coverage 31.40% 31.08% -0.32%
===========================================
Files 298 298
Lines 276125 276125
===========================================
- Hits 86717 85844 -873
- Misses 189408 190281 +873
... and 41 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
pavitthrap
approved these changes
Mar 15, 2023
The main goal of this commit is to resolve the issues where a newline was intended, but because Markdown formatting uses two newlines to separate paragraphs, these lines were being merged. This was especially apparent in the lists of possible error codes, which I've now reformatted to use bulleted lists.
|
Good first issue to review @soju-drinker. You should be getting contributor access later today! cc @wileyj |
jcnelson
approved these changes
Mar 17, 2023
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 main goal of this commit is to resolve the issues where a newline was intended, but because Markdown formatting uses two newlines to separate paragraphs, these lines were being merged into one. This was especially apparent in the lists of possible error codes, which I've now reformatted to use bulleted lists.
For example, the following string in the source:
Resulted in the this formatting on the docs site:
