document that an exception might be raised on parse()

This commit is contained in:
Josh Holtrop 2013-05-02 10:45:02 -04:00
parent 0b2193b3d4
commit e7164589ab

View File

@ -29,6 +29,9 @@ module Yawpa
# - +:posix_order+: Stop processing parameters when a non-option is seen.
# Set this to +true+ if you want to implement subcommands.
#
# An ArgumentParsingException will be raised if an unknown option is observed
# or insufficient arguments are present for an option.
#
# == Example +options+
#
# {