fix(graindoc): Escape * chars that would close markdown bold incorrectly #1685
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
phated
requested review from
marcusroberts,
peblair and
jozanza
as code owners
ospencer
approved these changes
Feb 20, 2023
This was referenced Feb 20, 2023
av8ta
pushed a commit
to av8ta/grain
that referenced
this pull request
Apr 11, 2023
…tly (grain-lang#1685) fix(graindoc): Escape * characters that would close markdown bold incorrectly
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.
This escapes any
*+characters at the beginning of a string passed toMarkdown.bold, any**+anywhere in the string, and any*+at the end of string. These all would cause the bold to be rendered improperly.I've also started adding tests for the markdown utils, to ensure this was working before applying to #1538
Closes #1550 - I know this said to escape
_but those don't actually effect the**added by bold so I'm not going to escape them right now.