summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorTheron Luhn <theron@luhn.com>2019-12-17 11:32:16 -0800
committerTheron Luhn <theron@luhn.com>2019-12-17 11:32:16 -0800
commit3b34a67aa3916a766369220a0185b648b9513489 (patch)
treebdf5cd305450872262518326294ac39df36985a0 /src
parent965dd8295fc9fade649ca61b899811492a0dd2f6 (diff)
downloadpyramid-3b34a67aa3916a766369220a0185b648b9513489.tar.gz
pyramid-3b34a67aa3916a766369220a0185b648b9513489.tar.bz2
pyramid-3b34a67aa3916a766369220a0185b648b9513489.zip
Improve docs for remember/forget.
Diffstat (limited to 'src')
-rw-r--r--src/pyramid/interfaces.py9
1 files changed, 5 insertions, 4 deletions
diff --git a/src/pyramid/interfaces.py b/src/pyramid/interfaces.py
index af3c61503..c4160cc2b 100644
--- a/src/pyramid/interfaces.py
+++ b/src/pyramid/interfaces.py
@@ -502,14 +502,15 @@ class ISecurityPolicy(Interface):
def remember(request, userid, **kw):
""" Return a set of headers suitable for 'remembering' the
- :term:`userid` named ``userid`` when set in a response. An
- individual authentication policy and its consumers can
- decide on the composition and meaning of ``**kw``.
+ :term:`userid` named ``userid`` when set in a response. An individual
+ security policy and its consumers can decide on the composition and
+ meaning of ``**kw``.
"""
def forget(request, **kw):
""" Return a set of headers suitable for 'forgetting' the
- current user on subsequent requests.
+ current user on subsequent requests. An individual security policy and
+ its consumers can decide on the composition and meaning of ``**kw``.
"""