summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLee Jarvis <lee@jarvis.co>2010-12-02 12:50:47 +0000
committerLee Jarvis <lee@jarvis.co>2010-12-02 12:50:47 +0000
commit9b788d825070434ae8ac8d907e53872cc163fe55 (patch)
treec8a5fbe284ffbcc1054d85cec277ae35f1b7af5c
parent253c5604bc320ad64c14dbf3bcde9799c897ad22 (diff)
downloadslop-9b788d825070434ae8ac8d907e53872cc163fe55.tar.gz
added parse raise documentation
-rw-r--r--lib/slop.rb1
1 files changed, 1 insertions, 0 deletions
diff --git a/lib/slop.rb b/lib/slop.rb
index 26fa0c1..d599217 100644
--- a/lib/slop.rb
+++ b/lib/slop.rb
@@ -64,6 +64,7 @@ class Slop
# Parse an Array (usually ARGV) of options
#
# @param [Array, #split] Array or String of options to parse
+ # @raise [MissingArgumentError] raised when a compulsory argument is missing
def parse(values=[])
values = values.split(/\s+/) if values.respond_to?(:split)