fix: markdown formatting in code review examples#671
Open
timdeschryver wants to merge 2 commits intogithub:mainfrom
Open
fix: markdown formatting in code review examples#671timdeschryver wants to merge 2 commits intogithub:mainfrom
timdeschryver wants to merge 2 commits intogithub:mainfrom
Conversation
Updated markdown code blocks for example comments in the code review instructions.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes markdown formatting in the code review instructions file by correctly nesting code blocks within example comments. The issue was that triple backticks were used for both outer and inner code blocks, preventing proper rendering of the nested code examples.
Changes:
- Updated example comment blocks to use quadruple backticks (````) instead of triple backticks (```) to properly nest code blocks
This file contains hidden or 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
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.
Updated markdown code blocks for example comments in the code review instructions.
Pull Request Checklist
npm startand verified thatREADME.mdis up to date.Description
The markdown code blocks are currently not well formatted in the "Example Comments" section. This also impacts the "Review Checklist" section.
This PR uses 4 ticks to create the example markdown templates, so that the code blocks (and text) of the markdown content blocks are correctly formatted.
Before:

After:

Type of Contribution
Additional Notes
By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.