Render command help text in book to avoid wrapping #364
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
The command `--help` text output in the book was very wide, which caused it to be clipped and require scrolling horizontally to see it all. This diff renders the text at 80 columns, which makes it visible without scrolling at reasonable screen sizes. To do this, `env::run` now checks for the presence of the environment variable `IMDL_TERM_WIDTH`, which, if set to a positive integer, will be passed to `Clap::set_term_width`. `bin/man` now uses this to render the help text at 80 characters. type: documentation pr: #364
casey
force-pushed
the
book-command-width
branch
from
db1410c to
f058072
Compare
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.
The command
--helptext output in the book was very wide, which causedit to be clipped and require scrolling horizontally to see it all.
This diff renders the text at 80 columns, which makes it visible without
scrolling at reasonable screen sizes.
To do this,
env::runnow checks for the presence of the environmentvariable
IMDL_TERM_WIDTH, which, if set to a positive integer, will bepassed to
Clap::set_term_width.bin/mannow uses this to render the help text at 80 characters.type: documentation