summaryrefslogtreecommitdiff
path: root/docs/narr
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/narr
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/narr')
-rw-r--r--docs/narr/security.rst24
1 files changed, 13 insertions, 11 deletions
diff --git a/docs/narr/security.rst b/docs/narr/security.rst
index 16718cfa4..f3879d0ba 100644
--- a/docs/narr/security.rst
+++ b/docs/narr/security.rst
@@ -595,19 +595,21 @@ that implements the following interface:
""" An object representing a Pyramid authentication policy. """
def authenticated_userid(self, request):
- """ Return the authenticated userid or ``None`` if no
- authenticated userid can be found. This method of the policy
- should ensure that a record exists in whatever persistent store is
- used related to the user (the user should not have been deleted);
- if a record associated with the current id does not exist in a
- persistent store, it should return ``None``."""
+ """ Return the authenticated :term:`userid` or ``None`` if
+ no authenticated userid can be found. This method of the
+ policy should ensure that a record exists in whatever
+ persistent store is used related to the user (the user
+ should not have been deleted); if a record associated with
+ the current id does not exist in a persistent store, it
+ should return ``None``."""
def unauthenticated_userid(self, request):
- """ Return the *unauthenticated* userid. This method performs the
- same duty as ``authenticated_userid`` but is permitted to return the
- userid based only on data present in the request; it needn't (and
- shouldn't) check any persistent store to ensure that the user record
- related to the request userid exists."""
+ """ Return the *unauthenticated* userid. This method
+ performs the same duty as ``authenticated_userid`` but is
+ permitted to return the userid based only on data present
+ in the request; it needn't (and shouldn't) check any
+ persistent store to ensure that the user record related to
+ the request userid exists."""
def effective_principals(self, request):
""" Return a sequence representing the effective principals