summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTim Smith <tsmith84@gmail.com>2020-07-28 10:33:20 -0700
committerTim Smith <tsmith84@gmail.com>2020-07-28 10:33:20 -0700
commit7e976aaa84a3423abaea8b02c3168c5063735a33 (patch)
treead1680616598f2396e1922b51bcfc79a9ffa19ce /README.md
parentd81f780663bd43f7c565f357094aea87f86262cc (diff)
downloadmixlib-cli-7e976aaa84a3423abaea8b02c3168c5063735a33.tar.gz
Fix minor typosspelling
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index daabf86..bddbf35 100644
--- a/README.md
+++ b/README.md
@@ -109,7 +109,7 @@ Given the following example:
```ruby
-# mycli.rb
+# my_cli.rb
class MyCLI
include Mixlib::CLI
@@ -166,7 +166,7 @@ In this example, --dep-one will be used. Note that dep_one will not have a valu
```bash
-$ ruby mycli.rb --dep-one
+$ ruby my_cli.rb --dep-one
-1/--dep-one: This flag is deprecated. Use -n/--arg-not-required instead
arg_not_required: true
@@ -178,12 +178,12 @@ that --arg-required will accept,a nd populate `:arg\_required` with
```bash
-$ ruby mycli.rb --dep-two z # 'q' maps to 'invalid' in the value_mapper proc above
+$ ruby my_cli.rb --dep-two z # 'q' maps to 'invalid' in the value_mapper proc above
-2/--dep-two: This flag is deprecated. Use -a/--arg-required instead.
arg_required: a # The value is mapped to its replacement using the function provided.
-dep_two: z # the deprected value is kept by default
+dep_two: z # the deprecated value is kept by default
```
In this example, the value provided to dep-two will be converted to a value
@@ -191,7 +191,7 @@ that --arg-required will reject, showing how content rules are applied even when
the input is coming from a deprecated option:
```bash
-$ ruby mycli.rb --dep-two q
+$ ruby my_cli.rb --dep-two q
-2/--dep-two: This flag is deprecated. Use -a/--arg-required instead.
-a/--arg-required: invalid is not one of the allowed values: 'a', 'b', or 'c'