document :boolean option flag

This commit is contained in:
josh committed 2014-06-25 15:15:09 -04:00
1 parent d33d082272
commit 0eb754814e
2 files changed
+7

No files matched your search

+3
View File
@@ -32,6 +32,7 @@ module Yawpa
# server: {nargs: (1..2)},
# username: {nargs: 1},
# password: {nargs: 1},
# color: {boolean: true},
# }
#
# The keys of the +options+ Hash can be either strings or symbols.
@@ -42,6 +43,8 @@ module Yawpa
# - +:short+: specify a short option letter to associate with the long option
# - +:nargs+: specify an exact number or range of possible numbers of
# arguments to the option
# - +:boolean+: if true, specify that the option is a toggleable boolean
# option and allow a prefix of "no" to turn it off.
#
# @param params [Array]
# List of program parameters to parse.