chore: improve CLI line breaks and markdown-handling #1736
Merged
+51
−19
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
for more information, see https://pre-commit.ci
…' into minor-cli-formating-improvements # Conflicts: # docs/src/run-with-cli.md # martin/src/args/srv.rs
CommanderStorm
changed the title
CommanderStorm
added a commit
to CommanderStorm/martin
that referenced
this pull request
Mar 10, 2025
During maplibre#1720 I noticed that there are a few places in the CLI where a few more line breaks and handling markdown better could help readability. Yes, this adds the `unstable-markdown` feature of clap, but given that removal would only impact the CLI-Formatting, I think here the risk is okay. Tracking issue: - clap-rs/clap#5900 Hidden rationale: I have one place in maplibre#1720 where making it readable without markdown formatting is nearly impossible --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
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.
During #1720 I noticed that there are a few places in the CLI where a few more line breaks and handling markdown better could help readability.
Yes, this adds the
unstable-markdownfeature of clap, but given that removal would only impact the CLI-Formatting, I think here the risk is okay.Tracking issue:
Hidden rationale:
I have one place in #1720 where making it readable without markdown formatting is nearly impossible