summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2018-04-11 23:04:31 -0700
committerGitHub <noreply@github.com>2018-04-11 23:04:31 -0700
commita851d05f76edc6bc6bf65269c20eeba7fe726ade (patch)
tree32cc537b6a367d82f19f865676d2f3d6beb6cdd1
parent9ebc009c5529fcc22eb6e72cb1ea61ef2516d5ff (diff)
parent073facffe63ddb9f73106bec4266d4783bb32132 (diff)
downloadpyramid-a851d05f76edc6bc6bf65269c20eeba7fe726ade.tar.gz
pyramid-a851d05f76edc6bc6bf65269c20eeba7fe726ade.tar.bz2
pyramid-a851d05f76edc6bc6bf65269c20eeba7fe726ade.zip
Merge pull request #3253 from jvanasco/fix-webob_updated
updated docs/interfaces to note change from webob 1.7/1.5
-rw-r--r--docs/narr/webob.rst4
-rw-r--r--pyramid/interfaces.py6
2 files changed, 5 insertions, 5 deletions
diff --git a/docs/narr/webob.rst b/docs/narr/webob.rst
index 406351562..4efe783b0 100644
--- a/docs/narr/webob.rst
+++ b/docs/narr/webob.rst
@@ -406,13 +406,13 @@ Here are some highlights:
``response.text``. ``response.content_type_params`` is a dictionary of all
the parameters.
-``response.set_cookie(key, value, max_age=None, path='/', ...)``
+``response.set_cookie(name, value, max_age=None, path='/', ...)``
Set a cookie. The keyword arguments control the various cookie parameters.
The ``max_age`` argument is the length for the cookie to live in seconds
(you may also use a timedelta object). The ``Expires`` key will also be
set based on the value of ``max_age``.
-``response.delete_cookie(key, path='/', domain=None)``
+``response.delete_cookie(name, path='/', domain=None)``
Delete a cookie from the client. This sets ``max_age`` to 0 and the cookie
value to ``''``.
diff --git a/pyramid/interfaces.py b/pyramid/interfaces.py
index e9cc007ac..bedfb60b3 100644
--- a/pyramid/interfaces.py
+++ b/pyramid/interfaces.py
@@ -180,7 +180,7 @@ class IResponse(Interface):
"""Gets and sets and deletes the Date header. For more information on
Date see RFC 2616 section 14.18. Converts using HTTP date.""")
- def delete_cookie(key, path='/', domain=None):
+ def delete_cookie(name, path='/', domain=None):
""" Delete a cookie from the client. Note that path and domain must
match how the cookie was originally set. This sets the cookie to the
empty string, and max_age=0 so that it should expire immediately. """
@@ -244,7 +244,7 @@ class IResponse(Interface):
""" Gets and sets and deletes the Server header. For more information
on Server see RFC216 section 14.38. """)
- def set_cookie(key, value='', max_age=None, path='/', domain=None,
+ def set_cookie(name, value='', max_age=None, path='/', domain=None,
secure=False, httponly=False, comment=None, expires=None,
overwrite=False):
""" Set (add) a cookie for the response """
@@ -259,7 +259,7 @@ class IResponse(Interface):
""" Get/set the unicode value of the body (using the charset of
the Content-Type)""")
- def unset_cookie(key, strict=True):
+ def unset_cookie(name, strict=True):
""" Unset a cookie with the given name (remove it from the
response)."""