diff options
| author | The Bundler Bot <bot@bundler.io> | 2017-08-29 16:31:19 +0000 |
|---|---|---|
| committer | The Bundler Bot <bot@bundler.io> | 2017-08-29 16:31:19 +0000 |
| commit | 2bf5fc5caa48ccaea8d34841c19ed31a0e045b71 (patch) | |
| tree | ab2163f94082c529151edae9d75a0eb7484c64f6 | |
| parent | 6ce61e7c6060d1d7a45a131031be472aa25e1d7e (diff) | |
| parent | 08716199290f069c154c34e017ea8442386557aa (diff) | |
| download | bundler-2bf5fc5caa48ccaea8d34841c19ed31a0e045b71.tar.gz | |
Auto merge of #5980 - NickLaMuro:change-gem-pristine-desc-to-long-desc, r=segiddins
Convert pristine command desc to long_desc
What was the end-user problem that led to this PR?
--------------------------------------------------
When taking a look at the output that was shown when doing `bundle cli_help`, half of the output for describing the `bundle pristine` command is truncated.
What was your diagnosis of the problem?
---------------------------------------
My diagnosis was that we had to long of a "basic description" (`desc`) for the `bundle pristine` command.
What is your fix for the problem, implemented in this PR?
---------------------------------------------------------
Convert the existing `desc` to a `long_desc`, and provide a shorter one for `desc`.
Why did you choose this fix out of the possible options?
--------------------------------------------------------
I chose this fix because it retained the same info that was there previously, but provided a much more terse description in summary like situations like `bundle cli_help`.
| -rw-r--r-- | lib/bundler/cli.rb | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/lib/bundler/cli.rb b/lib/bundler/cli.rb index 69bb5f0ac3..0386bb25ac 100644 --- a/lib/bundler/cli.rb +++ b/lib/bundler/cli.rb @@ -603,7 +603,12 @@ module Bundler Issue.new.run end - desc "pristine [GEMS...]", "Restores installed gems to pristine condition from files located in the gem cache. Gem installed from a git repository will be issued `git checkout --force`." + desc "pristine [GEMS...]", "Restores installed gems to pristine condition" + long_desc <<-D + Restores installed gems to pristine condition from files located in the + gem cache. Gems installed from a git repository will be issued `git + checkout --force`. + D def pristine(*gems) require "bundler/cli/pristine" Pristine.new(gems).run |