From: Ben Darnell <ben@bendarnell.com>
Date: Tue, 13 Aug 2013 03:52:30 +0000 (-0400)
Subject: Add comments for domain and path arguments to cookie-clearing methods.
X-Git-Tag: v3.2.0b1~96
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4a1f02463e6349d6c8bdc37a2f3691ff43dbb75c;p=thirdparty%2Ftornado.git

Add comments for domain and path arguments to cookie-clearing methods.
---

diff --git a/tornado/web.py b/tornado/web.py
index 1332924cd..5f8d6091b 100644
--- a/tornado/web.py
+++ b/tornado/web.py
@@ -437,13 +437,23 @@ class RequestHandler(object):
             morsel[k] = v
 
     def clear_cookie(self, name, path="/", domain=None):
-        """Deletes the cookie with the given name."""
+        """Deletes the cookie with the given name.
+
+        Due to limitations of the cookie protocol, you must pass the same
+        path and domain to clear a cookie as were used when that cookie
+        was set (but there is no way to find out on the server side
+        which values were used for a given cookie).
+        """
         expires = datetime.datetime.utcnow() - datetime.timedelta(days=365)
         self.set_cookie(name, value="", path=path, expires=expires,
                         domain=domain)
 
     def clear_all_cookies(self, path="/", domain=None):
-        """Deletes all the cookies the user sent with this request."""
+        """Deletes all the cookies the user sent with this request.
+
+        See `clear_cookie` for more information on the path and domain
+        parameters.
+        """
         for name in self.request.cookies:
             self.clear_cookie(name, path=path, domain=domain)