summaryrefslogtreecommitdiff
path: root/docs/api/request.rst
diff options
context:
space:
mode:
authorKarl O. Pinc <kop@meme.com>2014-08-12 22:12:25 -0500
committerKarl O. Pinc <kop@meme.com>2014-08-12 22:12:25 -0500
commitdc324784193a577bc039dcddb0651ef5ec9e6f57 (patch)
treea7b5e7b9f9de3815d2386ecb6a1e81cf48854c66 /docs/api/request.rst
parentc7afe4e43ab19a5e8274988fe8dd004c04c160a1 (diff)
downloadpyramid-dc324784193a577bc039dcddb0651ef5ec9e6f57.tar.gz
pyramid-dc324784193a577bc039dcddb0651ef5ec9e6f57.tar.bz2
pyramid-dc324784193a577bc039dcddb0651ef5ec9e6f57.zip
Docs: Make "userid" link to the glossary term.
Diffstat (limited to 'docs/api/request.rst')
-rw-r--r--docs/api/request.rst31
1 files changed, 16 insertions, 15 deletions
diff --git a/docs/api/request.rst b/docs/api/request.rst
index 3a32fd938..4f93fa34f 100644
--- a/docs/api/request.rst
+++ b/docs/api/request.rst
@@ -167,27 +167,28 @@
.. versionadded:: 1.5
- A property which returns the userid of the currently authenticated user
- or ``None`` if there is no :term:`authentication policy` in effect or
- there is no currently authenticated user. This differs from
- :attr:`~pyramid.request.Request.unauthenticated_userid`, because the
- effective authentication policy will have ensured that a record
- associated with the userid exists in persistent storage; if it has
- not, this value will be ``None``.
+ A property which returns the :term:`userid` of the currently
+ authenticated user or ``None`` if there is no :term:`authentication
+ policy` in effect or there is no currently authenticated user. This
+ differs from :attr:`~pyramid.request.Request.unauthenticated_userid`,
+ because the effective authentication policy will have ensured that a
+ record associated with the :term:`userid` exists in persistent storage; if it
+ has not, this value will be ``None``.
.. attribute:: unauthenticated_userid
.. versionadded:: 1.5
A property which returns a value which represents the *claimed* (not
- verified) user id of the credentials present in the request. ``None`` if
- there is no :term:`authentication policy` in effect or there is no user
- data associated with the current request. This differs from
- :attr:`~pyramid.request.Request.authenticated_userid`, because the
- effective authentication policy will not ensure that a record associated
- with the userid exists in persistent storage. Even if the userid
- does not exist in persistent storage, this value will be the value
- of the userid *claimed* by the request data.
+ verified) :term:`userid` of the credentials present in the
+ request. ``None`` if there is no :term:`authentication policy` in effect
+ or there is no user data associated with the current request. This
+ differs from :attr:`~pyramid.request.Request.authenticated_userid`,
+ because the effective authentication policy will not ensure that a
+ record associated with the :term:`userid` exists in persistent storage.
+ Even if the :term:`userid` does not exist in persistent storage, this
+ value will be the value of the :term:`userid` *claimed* by the request
+ data.
.. attribute:: effective_principals