summaryrefslogtreecommitdiff
path: root/doc/option_parsing.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/option_parsing.rst')
-rw-r--r--doc/option_parsing.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/option_parsing.rst b/doc/option_parsing.rst
index 2dced82..fa928e0 100644
--- a/doc/option_parsing.rst
+++ b/doc/option_parsing.rst
@@ -12,7 +12,8 @@ Characteristics:
* recognition of the double dash as option list terminator
* offers POSIX strictness where the option list terminates at the first
non-option argument
-* option passthrough
+* option passthrough (conceptuall only works for options taking no argument,
+ or when the argument is joined to a long option with a '=')
* the parse function is one-shot; there is no context object (like popt),
no global state (like getopt) and no ``while`` loop (either of the two others)
* exclusively uses an option table