[MRG] No need to monkey-patch Click.HelpFormatter #5
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.
While working on adding tests for Excalibur (camelot-dev/excalibur#49), I've noticed this code:
This monkey patching causes Excalibur's (or any other click-based) CLI to return camelot for the program name in the help output, which is a bit confusing, so I decided to propose this PR to fix it.
In order not to show camelot as the program name in the help output (passing --help), it's enough to set
@group(name='camelot')
on the main Click group for the CLI. The existing approach which monkey patchesclick.HelpFormatter.write_usage()
, will affect any other Click CLI tool that uses camelot as its dependency, e.g. Excalibur.Added a test to verify it works as expected in the help output.