From 63f7ae00096e1121504d43ddcbefbd1e5293a985 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Wed, 30 Oct 2013 20:13:15 -0400 Subject: wording --- pyramid/security.py | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/pyramid/security.py b/pyramid/security.py index f86b7e43a..f7750cbef 100644 --- a/pyramid/security.py +++ b/pyramid/security.py @@ -379,12 +379,13 @@ class AuthenticationAPIMixin(object): return policy.remember(self, principal, **kw) def remember_userid(self, principal, on_exception=False, **kw): - """ Sets a sequence of header tuples (e.g. ``[('Set-Cookie', - 'foo=abc')]``) on the response eventually returned using a response - callback. These headers are used for 'remembering' a set of - credentials implied by the data passed as ``principal`` and ``*kw`` - using the current :term:`authentication policy`. Common usage might - look like so within the body of a view function: + """ Using a response callback, sets authentication headers on the + response eventually returned by the view executed by this request + suitable for loggin a user in. These headers are used for + 'remembering' a set of credentials implied by the data passed as + ``principal`` and ``*kw`` using the current :term:`authentication + policy`. Common usage might look like so within the body of a view + function: .. code-block:: python @@ -430,10 +431,9 @@ class AuthenticationAPIMixin(object): return policy.forget(self) def forget_userid(self, on_exception=False): - """ Sets a sequence of header tuples (e.g. ``[('Set-Cookie', - 'foo=abc')]``) suitable for 'forgetting' the set of credentials - possessed by the currently authenticated user on the response based on - the current :term:`authentication policy`, using a response callback. + """ Using a response callback, sets authentication headers suitable for + logging a user out on the response returned by the view executed during + this request based on the current :term:`authentication policy`. If no :term:`authentication policy` is in use, this function will be a noop. -- cgit v1.2.3