Document the Response.close() method.
authorCory Benfield <lukasaoz@gmail.com>
Thu, 25 Jul 2013 18:10:42 +0000 (19:10 +0100)
committerCory Benfield <lukasaoz@gmail.com>
Thu, 25 Jul 2013 18:10:42 +0000 (19:10 +0100)
requests/models.py

index 667b001..b5b1bd0 100644 (file)
@@ -689,4 +689,9 @@ class Response(object):
             raise HTTPError(http_error_msg, response=self)
 
     def close(self):
+        """Closes the underlying file descriptor and releases the connection
+        back to the pool.
+
+        *Note: Should not normally need to be called explicitly.*
+        """
         return self.raw.release_conn()