Fix examples.md template: escape comment markers #45
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.
Summary
<!--and-->) in the regex pattern to prevent markdown parsers from breakingProblem
The regex pattern in the CODE block contained literal
<!-- SECTION:github-actions:START -->.*?<!-- SECTION:github-actions:END -->which has nested<!--and-->inside the markdown comment. This caused the markdown renderer to interpret the first-->as ending the comment, making the rest of the pattern appear as visible text on the docs site.Solution
Break up the string using concatenation so
-->doesn't appear literally:Test plan
docs_gen.py --verifypassesdocs_gen.py --docs-onlygenerates correct output