Fix whitespace formatting in CLI help. #917
Merged
Conversation
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
For traitlets that have long descriptions, and in particular that uses
multiline strings, this lead to inconsistant indentation – and mmissing
newlines in rewrapped paragraphs.
- Each paragraph in wrap_paragraphs would be a list item, and thus need
to be joined by 2 newlines (or we need to ensure that each list item
in wrap_paragraph would end in a NL, but that woudl change API
- When help is ina multiline string, if the line start on the first
line:
"""like in
this kind of help"""
but not like
"""
in this kind
of documentation help
"""
Wrap parragraph would not properly dedent.
Member
|
Thanks! |
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.
For traitlets that have long descriptions, and in particular that uses multiline strings, this lead to inconsistant indentation – and mmissing newlines in rewrapped paragraphs.
Each paragraph in wrap_paragraphs would be a list item, and thus need to be joined by 2 newlines (or we need to ensure that each list item in wrap_paragraph would end in a NL, but that woudl change API
When help is ina multiline string, if the line start on the first line:
"""like in
this kind of help"""
but not like
"""
in this kind
of documentation help
"""
Wrap parragraph would not properly dedent.