docs: hard wrap help text for options#1854
Merged
mre merged 2 commits intolycheeverse:masterfrom Sep 15, 2025
Merged
Conversation
Member
|
Definitely an improvement. Thanks! |
Closed
This was referenced Oct 21, 2025
Closed
Merged
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
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.
most of the options already have hard-wrapped
long_help. however, for a few options which defined their help text in///comments, these would get joined into one long line. this was the[inputs],--scheme, and--cookie-jar.i've sorted the lines in
--helpby length before and after this change:old.txt
new.txt
previously, the longest line was 353 characters and after this change it is 126.
this change will make the cli options webpage a bit easier to read, as it makes you scroll to the right if the line is long. though, maybe other solutions can be done instead (maybe generate markdown from the options, or maybe enable wrapping on the webpage).