_includes/cli.md: fix flag descriptions with < and > #12083
Merged
Conversation
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
Member
Author
Member
Author
|
Hmm, Netlify failed; doesn't look related, but not sure how to restart it |
Member
Author
|
close/reopen didn't seem to trigger it again; let me rebase/push |
Some flag descriptions contain point-brackets to indicate required
options, e.g.:
--ssh stringArray SSH agent socket or keys to expose to the build (format: default|<id>[=<socket>|<key>[,<key>]])
When rendering those options as HTML, those options were not visible as
they were rendered as a HTML element.
Given that flag-descriptions are not expected to have MarkDown or HTML
formatting, we can HTML-escape them to prevent this.
This patch escapes the flag-descriptions using liquid's `esacape` command.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
thaJeztah
force-pushed
the
fix_flag_descriptions
branch
from
fd8cf8e to
ac39688
Compare
|
✔️ Deploy preview for docsdocker ready! 🔨 Explore the source changes: ac39688 🔍 Inspect the deploy logs: https://app.netlify.com/sites/docsdocker/deploys/5ffec14dd22ca500070cbc17 😎 Browse the preview: https://deploy-preview-12083--docsdocker.netlify.app |
Member
Author
|
All green now; @StefanScherer @usha-mandya ptal 🤗 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
fixes #11331
replaces / closes #12064
Some flag descriptions contain point-brackets to indicate required options, e.g.:
When rendering those options as HTML, those options were not visible as
they were rendered as a HTML element.
Given that flag-descriptions are not expected to have MarkDown or HTML
formatting, we can HTML-escape them to prevent this.
This patch escapes the flag-descriptions using liquid's
esacapecommand.Before this patch:
After this patch: