Last round of softwrapping help strings #15142
Merged
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
# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]
thejcannon
commented
Apr 14, 2022
| help=softwrap( | ||
| """ | ||
| Config schema is as follows: | ||
|
|
There was a problem hiding this comment.
You don't need the triple backticks on blocks indented 4 spaces. Markdown will render those as code blocks any way, and leaving them out gives less noise for the CLI help output ;)
There was a problem hiding this comment.
If we're going to make a stand on that (and maybe we should?) We should do it project-wide.
There was a problem hiding this comment.
I'm not sure which style we should go with, but agree that it makes sense to be consistent. I think the part I care about is indentation because it makes things more skimmable.
There was a problem hiding this comment.
Agreed. And I think less noise helps with skimmability, and if we can get rid of ``` then that's less noise too ;)
kaos
approved these changes
Apr 15, 2022
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.
There's still tons more user-visible strings, but this neatly wraps up
helpstrings at least.[ci skip-rust]
[ci skip-build-wheels]