diff options
| author | Chris McDonough <chrism@plope.com> | 2011-08-09 21:32:30 -0700 |
|---|---|---|
| committer | Chris McDonough <chrism@plope.com> | 2011-08-09 21:32:30 -0700 |
| commit | 65de433df573eccdc9911f0675dcc342dfe1c8ca (patch) | |
| tree | c4fda18a29ae158b967dc5639e71c321df5bc2e8 /docs | |
| parent | 7d75b9711290da353077d87323ba0ccc1c1918ab (diff) | |
| parent | fecefff5f0c3a6aaafdd43d902aaed15edb8559e (diff) | |
| download | pyramid-65de433df573eccdc9911f0675dcc342dfe1c8ca.tar.gz pyramid-65de433df573eccdc9911f0675dcc342dfe1c8ca.tar.bz2 pyramid-65de433df573eccdc9911f0675dcc342dfe1c8ca.zip | |
Merge pull request #250 from mmerickel/feature.no-perm-const
Added the `pyramid.security.NO_PERMISSION_REQUIRED` constant.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/config.rst | 2 | ||||
| -rw-r--r-- | docs/api/security.rst | 2 | ||||
| -rw-r--r-- | docs/narr/security.rst | 9 |
3 files changed, 8 insertions, 5 deletions
diff --git a/docs/api/config.rst b/docs/api/config.rst index 1a9bb6ba4..30c541905 100644 --- a/docs/api/config.rst +++ b/docs/api/config.rst @@ -44,7 +44,7 @@ .. automethod:: add_route - .. automethod:: add_static_view(name, path, cache_max_age=3600, permission='__no_permission_required__') + .. automethod:: add_static_view(name, path, cache_max_age=3600, permission=NO_PERMISSION_REQUIRED) .. automethod:: add_settings diff --git a/docs/api/security.rst b/docs/api/security.rst index de249355d..8cd9e5dae 100644 --- a/docs/api/security.rst +++ b/docs/api/security.rst @@ -57,6 +57,8 @@ Constants last ACE in an ACL in systems that use an "inheriting" security policy, representing the concept "don't inherit any other ACEs". +.. attribute:: NO_PERMISSION_REQUIRED + Return Values ------------- diff --git a/docs/narr/security.rst b/docs/narr/security.rst index ce304ed9f..a61578e21 100644 --- a/docs/narr/security.rst +++ b/docs/narr/security.rst @@ -200,9 +200,9 @@ When a default permission is registered: permission is ignored for that view registration, and the view-configuration-named permission is used. -- If a view configuration names an explicit permission as the string - ``__no_permission_required__``, the default permission is ignored, - and the view is registered *without* a permission (making it +- If a view configuration names the permission + :data:`pyramid.security.NO_PERMISSION_REQUIRED`, the default permission + is ignored, and the view is registered *without* a permission (making it available to all callers regardless of their credentials). .. warning:: @@ -210,7 +210,8 @@ When a default permission is registered: When you register a default permission, *all* views (even :term:`exception view` views) are protected by a permission. For all views which are truly meant to be anonymously accessible, you will need to associate the view's - configuration with the ``__no_permission_required__`` permission. + configuration with the :data:`pyramid.security.NO_PERMISSION_REQUIRED` + permission. .. index:: single: ACL |