summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorMichael Merickel <michael@merickel.org>2020-11-28 23:13:33 -0600
committerMichael Merickel <michael@merickel.org>2020-11-28 23:13:33 -0600
commit30cd9bcee5115f18f1d20eaa74a7e5753260f0ac (patch)
treea3dbd1011253c2c836b27adc843ff9131b78ccb6 /src
parent46a9c339cdbdf9e78f585026054e3ecdba2ee53d (diff)
downloadpyramid-30cd9bcee5115f18f1d20eaa74a7e5753260f0ac.tar.gz
pyramid-30cd9bcee5115f18f1d20eaa74a7e5753260f0ac.tar.bz2
pyramid-30cd9bcee5115f18f1d20eaa74a7e5753260f0ac.zip
fix a few references
Diffstat (limited to 'src')
-rw-r--r--src/pyramid/interfaces.py11
1 files changed, 9 insertions, 2 deletions
diff --git a/src/pyramid/interfaces.py b/src/pyramid/interfaces.py
index cd2818c22..6704f7c7c 100644
--- a/src/pyramid/interfaces.py
+++ b/src/pyramid/interfaces.py
@@ -116,7 +116,7 @@ class IResponse(Interface):
identity = Attribute(
"""An object containing authentication information related to the
current request. The object's type and meaning is defined by the
- configured security policy."""
+ configured :term:`security policy`."""
)
authenticated_userid = Attribute(
@@ -245,7 +245,11 @@ class IResponse(Interface):
is_authenticated = Attribute(
"""A boolean indicating whether the request has an authenticated
- user, as determined by the security policy in use."""
+ user, as determined by the security policy in use.
+
+ The value is determined by the result of
+ :attr:`pyramid.request.Request.authenticated_userid`.
+ """
)
last_modified = Attribute(
@@ -506,6 +510,9 @@ class ISecurityPolicy(Interface):
def authenticated_userid(request):
"""Return a :term:`userid` string identifying the trusted and
verified user, or ``None`` if unauthenticated.
+
+ If the result is ``None``, then
+ :attr:`pyramid.request.Request.is_authenticated` will return ``False``.
"""
def permits(request, context, permission):