Permalink
Browse files

update inconsistent effective_principals docs

fixes #1196
  • Loading branch information...
1 parent 3063246 commit 82ec99eebc6a6dfe2903bc0383f31a9b146b3d80 @mmerickel mmerickel committed Mar 4, 2014
Showing with 3 additions and 4 deletions.
  1. +3 −4 pyramid/security.py
View
@@ -340,10 +340,9 @@ def unauthenticated_userid(self):
@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
"""

0 comments on commit 82ec99e

Please sign in to comment.