Comments (6)
Yeah, defaulting to longer help strings seems totally reasonable with the improved readability from rich-click
. Having a config option to preserve native click
truncating might be nice if someone really needs identical behavior, but as long as you can manually override the automatic truncation using short_help
, it doesn't seem like a big deal to me.
from rich-click.
Works perfectly. Thanks again @ewels!
from rich-click.
Published in v1.2.1 https://pypi.org/project/rich-click/1.2.1/
from rich-click.
Thanks for reporting this - I noticed the short_help
argument out of the corner of my eye a little while ago and meant to check to see if it was used but then forgot about it. We should definitely use that if supplied 👍🏻
Regarding the second bit about truncating after the first sentence (.
). This was a mostly deliberate choice, as generally the wider terminal output and nicer formatting should allow longer strings for rich-click
than for native click. I can see how the change in behaviour could cause issues though. I'm inclined to say that we either do nothing about this, or add a new option to take the option/arg short text from the click functions (so truncating exactly as with native). What do you think?
from rich-click.
Ok, short_help
should now be supported (in an almost suspiciously small amount of additional code..)
from rich-click.
Ok, and added a USE_CLICK_SHORT_HELP
global which uses the default click handling for commands. Setting this to True
will then do the stuff with the first sentence and adding ellipses etc. as with vanilla click.
Thanks for reporting!
from rich-click.
Related Issues (20)
- Command Aliases? HOT 1
- options inherited from context settings aren't applied (#2) HOT 1
- Inconsistent highlighting in help section HOT 9
- Allow adding extra lines to separate commands/parameters HOT 7
- Typer AttributeError in latest release HOT 3
- Default colors hard to read on Windows terminals HOT 7
- Markup and rich formatting in click.echo HOT 5
- `py.typed` not getting distributed HOT 11
- Hyperlinks seems not working when using with Typer HOT 3
- Are custom group classes supported? HOT 1
- Hide env var defaults for automatically generated completion flags HOT 1
- Untyped decorator issue with rich-click HOT 2
- Rich-click does not format nested commands HOT 7
- Provide help message when --help is used in a cli with required arguments HOT 2
- Rich Click breaks contract of Click's `format_help` and its callers
- Make `rich-click` extensible and isolate configuration state HOT 3
- click.ClickException should output to stderr HOT 4
- Multiple times argument usage HOT 1
- Click fails in command
- Broken image links on PyPI page for rich-click HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from rich-click.