From e7164589abf80dee331fec49a0f0afc3b92f4ad6 Mon Sep 17 00:00:00 2001
From: Josh Holtrop <jholtrop@gmail.com>
Date: Thu, 2 May 2013 10:45:02 -0400
Subject: [PATCH] document that an exception might be raised on parse()

---
 lib/yawpa.rb | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/lib/yawpa.rb b/lib/yawpa.rb
index 661f24e..b076f54 100644
--- a/lib/yawpa.rb
+++ b/lib/yawpa.rb
@@ -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+
   #
   #   {