summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBryan McLellan <btm@loftninjas.org>2019-05-13 14:03:05 -0400
committerBryan McLellan <btm@loftninjas.org>2019-05-13 14:03:05 -0400
commitd76f128d462840a707b0941ee468ab09abfc6f74 (patch)
tree8b2c93b709e6d199c98d575aa4ab11c6e240048f
parent5f0e3706dfc00c5175669720e04c4bff38a7d96f (diff)
downloadmixlib-cli-btm/included_text.tar.gz
Improve the --help text output of 'in:'btm/included_text
The automatic addition of the 'in' options to the --help output could be more clear about what the list is. Signed-off-by: Bryan McLellan <btm@loftninjas.org>
-rw-r--r--lib/mixlib/cli.rb2
-rw-r--r--spec/mixlib/cli_spec.rb2
2 files changed, 2 insertions, 2 deletions
diff --git a/lib/mixlib/cli.rb b/lib/mixlib/cli.rb
index 0516926..cfc642d 100644
--- a/lib/mixlib/cli.rb
+++ b/lib/mixlib/cli.rb
@@ -313,7 +313,7 @@ module Mixlib
if opt_setting.key?(:description)
description = opt_setting[:description].dup
description << " (required)" if opt_setting[:required]
- description << " (included in ['#{opt_setting[:in].join("', '")}'])" if opt_setting[:in]
+ description << " (valid options are: ['#{opt_setting[:in].join("', '")}'])" if opt_setting[:in]
opt_setting[:description] = description
arguments << description
end
diff --git a/spec/mixlib/cli_spec.rb b/spec/mixlib/cli_spec.rb
index aa08744..c9bc5e4 100644
--- a/spec/mixlib/cli_spec.rb
+++ b/spec/mixlib/cli_spec.rb
@@ -228,7 +228,7 @@ describe Mixlib::CLI do
TestCLI.option(:inclusion, short: "-i val", in: %w{one two}, description: "desc", required: false)
@cli = TestCLI.new
@cli.parse_options(["-i", "one"])
- expect(@cli.options[:inclusion][:description]).to eql("desc (included in ['one', 'two'])")
+ expect(@cli.options[:inclusion][:description]).to eql("desc (valid options are: ['one', 'two'])")
end
it "doesn't exit if a required option is specified" do