Docs: Improve readability of values for flags in markdown #136
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.
I want to propose to roll out the change showecased in this PR to the whole readme.
My issue is, that I find the current formatting where the example value is italic but not part of the
<code>
tag very hard to read.I propose to use some other way to signal that som strings are placeholder text and wrap the whole segment as a code block.
After:
I picked
<example_value>
, but other wrappers would be possible to, of course.I did not do this for the whole readme, yet, in order to first get feedback if this PR would be welcome.