🐛 [-bug] Fix markdown rendering issue #35
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
With the previous change, comments delimiting sections dynamically populated are preserved to support better git diffs. However, this caused a regression in how markdown tables are rendered, as the HTML comments were embedded within the table, breaking GitHub's ability to render the markdown table. The fix is to move the delimiting comment outside of the table definition.
davidbrownell
requested review from
krachwal,
loriab,
ketanbj,
jyoung3131,
rfievet and
varun646
krachwal
approved these changes
Sep 17, 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.
📝 Description
With the previous change, comments delimiting sections dynamically populated are preserved to support better git diffs. However, this caused a regression in how markdown tables are rendered, as the HTML comments were embedded within the table, breaking GitHub's ability to render the markdown table. The fix is to move the delimiting comment outside of the table definition.
⚙️ Work Item
N/A
🎥 Demo
Before
After