summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Merickel <michael@merickel.org>2014-03-03 16:36:04 -0800
committerMichael Merickel <michael@merickel.org>2014-03-04 22:32:16 -0600
commit82ec99eebc6a6dfe2903bc0383f31a9b146b3d80 (patch)
treee42e8d0050f8cc06f412978352c47a1de6754105
parent3063246aa418ae2008adb48ab9e5090a88be42d4 (diff)
downloadpyramid-82ec99eebc6a6dfe2903bc0383f31a9b146b3d80.tar.gz
pyramid-82ec99eebc6a6dfe2903bc0383f31a9b146b3d80.tar.bz2
pyramid-82ec99eebc6a6dfe2903bc0383f31a9b146b3d80.zip
update inconsistent effective_principals docs
fixes #1196
-rw-r--r--pyramid/security.py7
1 files changed, 3 insertions, 4 deletions
diff --git a/pyramid/security.py b/pyramid/security.py
index aa4aece69..c98d4e6cc 100644
--- a/pyramid/security.py
+++ b/pyramid/security.py
@@ -340,10 +340,9 @@ class AuthenticationAPIMixin(object):
@property
def effective_principals(self):
""" Return the list of 'effective' :term:`principal` identifiers
- for the ``request``. This will include the userid of the
- currently authenticated user if a user is currently
- authenticated. If no :term:`authentication policy` is in effect,
- this will return an empty sequence.
+ for the ``request``. If no :term:`authentication policy` is in effect,
+ this will return a one-element list containing the
+ :data:`pyramid.security.Everyone` principal.
.. versionadded:: 1.5
"""