Introduce DESCRIPTION_MORE attribute #378
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
acehreli
force-pushed
the
description_more
branch
from
35355fe to
e4cb7db
Compare
1 similar comment
acehreli
force-pushed
the
description_more
branch
2 times, most recently
from
56a816b to
7bd9e77
Compare
|
Closing this one as I'm not happy with how paragraphs and wrapping are handled. |
acehreli
force-pushed
the
description_more
branch
from
7bd9e77 to
76e8e22
Compare
|
We've been using this change in production for about three weeks now. |
henryiii
requested changes
Apr 3, 2018
plumbum/cli/application.py
Outdated
| # Add to current paragraph | ||
| paragraph = paragraph + ' ' + line | ||
|
|
||
| yield from current() |
There was a problem hiding this comment.
Your production must not use Python 2 (must be nice...). This yield from should be very easy to convert to:
for item in current()
yield itemSince it is an iterator and not a generator.
plumbum/cli/application.py
Outdated
|
|
||
| if len(line) == 0: | ||
| # Starting a new paragraph | ||
| yield from current() |
acehreli
force-pushed
the
description_more
branch
from
941b9ee to
b738842
Compare
|
Thanks, henryiii... |
henryiii
approved these changes
Apr 10, 2018
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.
This change adds a new attribute to be printed between DESCRIPTION and USAGE.
Paragraphs are determined by empty lines inside DESCRIPTION_MORE. Paragraph indentations are preserved and lines are wrapped. Additionally, extra spaces are removed from text.
Instead of relying on a general purpose markup language package, this change brings a minor markup feature: It recognizes lists from their first character so that the whole list does not become one large paragraph. * and - are visible bullet characters and appear as such:
/ is bullet as well, but it is not printed on the output. This:
becomes this: