summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMichael Merickel <github@m.merickel.org>2018-11-01 14:31:37 -0500
committerGitHub <noreply@github.com>2018-11-01 14:31:37 -0500
commitaa1660f3d9a5dc654a91544d72de596af2fdf9ba (patch)
tree5f489b644f1571aef94bb61e9baee0bab9407a74 /docs
parent04eff2cc3ab71f0c38583647b047fff9447b7668 (diff)
parentf229f02f7c96ba81f1827973458fd0c5843235f1 (diff)
downloadpyramid-aa1660f3d9a5dc654a91544d72de596af2fdf9ba.tar.gz
pyramid-aa1660f3d9a5dc654a91544d72de596af2fdf9ba.tar.bz2
pyramid-aa1660f3d9a5dc654a91544d72de596af2fdf9ba.zip
Merge pull request #3410 from mmerickel/remove-deprecated-security-functions
remove deprecated security functions
Diffstat (limited to 'docs')
-rw-r--r--docs/api/security.rst8
-rw-r--r--docs/designdefense.rst5
2 files changed, 2 insertions, 11 deletions
diff --git a/docs/api/security.rst b/docs/api/security.rst
index 116459226..edb66472e 100644
--- a/docs/api/security.rst
+++ b/docs/api/security.rst
@@ -8,12 +8,6 @@
Authentication API Functions
----------------------------
-.. autofunction:: authenticated_userid
-
-.. autofunction:: unauthenticated_userid
-
-.. autofunction:: effective_principals
-
.. autofunction:: forget
.. autofunction:: remember(request, userid, **kwargs)
@@ -21,8 +15,6 @@ Authentication API Functions
Authorization API Functions
---------------------------
-.. autofunction:: has_permission
-
.. autofunction:: principals_allowed_by_permission
.. autofunction:: view_execution_permitted
diff --git a/docs/designdefense.rst b/docs/designdefense.rst
index 0f452ffde..566ad1f5e 100644
--- a/docs/designdefense.rst
+++ b/docs/designdefense.rst
@@ -181,15 +181,14 @@ developer needs to understand a ZCA concept or API during the creation of a
Instead the framework hides the presence of the ZCA registry behind
special-purpose API functions that *do* use ZCA APIs. Take for example the
-``pyramid.security.authenticated_userid`` function, which returns the userid
+``request.authenticated_userid`` function, which returns the userid
present in the current request or ``None`` if no userid is present in the
current request. The application developer calls it like so:
.. code-block:: python
:linenos:
- from pyramid.security import authenticated_userid
- userid = authenticated_userid(request)
+ userid = request.authenticated_userid
They now have the current user id.