From: Georg Brandl <georg@python.org>
Date: Wed, 16 Jul 2008 22:09:17 +0000 (+0000)
Subject: #3345: fix docstring.
X-Git-Tag: v2.6b2~15
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=4ed9be733b58712e3e91dafa5ab13cc0a6d99702;p=python

#3345: fix docstring.
---

diff --git a/Lib/CGIHTTPServer.py b/Lib/CGIHTTPServer.py
index 06278df04a..71f0368785 100644
--- a/Lib/CGIHTTPServer.py
+++ b/Lib/CGIHTTPServer.py
@@ -70,17 +70,18 @@ class CGIHTTPRequestHandler(SimpleHTTPServer.SimpleHTTPRequestHandler):
             return SimpleHTTPServer.SimpleHTTPRequestHandler.send_head(self)
 
     def is_cgi(self):
-        """Test whether self.path corresponds to a CGI script.
+        """Test whether self.path corresponds to a CGI script,
+        and return a boolean.
 
-        Return a tuple (dir, rest) if self.path requires running a
-        CGI script, None if not.  Note that rest begins with a
+        This function sets self.cgi_info to a tuple (dir, rest)
+        when it returns True, where dir is the directory part before
+        the CGI script name.  Note that rest begins with a
         slash if it is not empty.
 
         The default implementation tests whether the path
         begins with one of the strings in the list
         self.cgi_directories (and the next character is a '/'
         or the end of the string).
-
         """
 
         path = self.path