summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-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
"""