From: Andrew M. Kuchling <amk@amk.ca>
Date: Fri, 14 Nov 2008 00:11:12 +0000 (+0000)
Subject: Backport r66804: #1415508 from Rocky Bernstein: add docstrings for enable_intersperse... 
X-Git-Tag: v2.5.3c1~24
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=8b2b75692a7f18ecaf123aa429096c1c9b439b15;p=python

Backport r66804: #1415508 from Rocky Bernstein: add docstrings for enable_interspersed_args(), disable_interspersed_args()
---

diff --git a/Lib/optparse.py b/Lib/optparse.py
index 5aa3b967b0..d41ad3d61e 100644
--- a/Lib/optparse.py
+++ b/Lib/optparse.py
@@ -1281,9 +1281,19 @@ class OptionParser (OptionContainer):
             self.usage = usage
 
     def enable_interspersed_args(self):
+        """Set parsing to not stop on the first non-option, allowing
+        interspersing switches with command arguments. This is the
+        default behavior. See also disable_interspersed_args() and the
+        class documentation description of the attribute
+        allow_interspersed_args."""
         self.allow_interspersed_args = True
 
     def disable_interspersed_args(self):
+        """Set parsing to stop on the first non-option. Use this if
+        you have a command processor which runs another command that
+        has options of its own and you want to make sure these options
+        don't get confused.
+        """
         self.allow_interspersed_args = False
 
     def set_process_default_values(self, process):