fix(site): escape flags with backticks #4479
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
julio-lopez
requested changes
Apr 1, 2025
In the generated markdown docs, flags like `--foo` inside help texts currently get pretty-printed as `–foo` with an em-dash. This commit applies backticks via a regex replacement, so that they appear as `--foo` in the docs but remain as --foo in the CLI output.
abcc7d9 to
5554b4a
Compare
Contributor
Author
|
@julio-lopez bump |
julio-lopez
requested changes
Apr 24, 2025
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4479 +/- ##
==========================================
+ Coverage 75.86% 76.38% +0.51%
==========================================
Files 470 527 +57
Lines 37301 40047 +2746
==========================================
+ Hits 28299 30590 +2291
- Misses 7071 7439 +368
- Partials 1931 2018 +87 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
julio-lopez
requested changes
Apr 24, 2025
julio-lopez
approved these changes
Apr 24, 2025
Contributor
Author
|
Thanks for the merge! ^^ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
In the generated markdown docs, flags like
--fooinside help texts currently get pretty-printed as–foowith an em-dash.This PR applies backticks via a regex replacement (run by
cli2md), so that they appear as--fooin the docs but remain as --foo (without backticks) in the CLI output.See also #4341