]> granicus.if.org Git - python/commitdiff
#3345: fix docstring.
authorGeorg Brandl <georg@python.org>
Wed, 16 Jul 2008 22:09:17 +0000 (22:09 +0000)
committerGeorg Brandl <georg@python.org>
Wed, 16 Jul 2008 22:09:17 +0000 (22:09 +0000)
Lib/CGIHTTPServer.py

index 06278df04ad3b4a9409a5d50e94f23b12f74d5fa..71f03687856071af72aced72043bee07450b90a2 100644 (file)
@@ -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