diff options
| author | Michael Merickel <michael@merickel.org> | 2020-01-14 15:52:54 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-01-14 15:52:54 -0600 |
| commit | 32fca41e49875764ff7faf04f430a75344035d96 (patch) | |
| tree | aeadf98046f5a0f164c0b219de27e8a19a4d4188 /docs | |
| parent | f486795cb4a92784fa1082bd69bebd84bf6d1366 (diff) | |
| download | pyramid-32fca41e49875764ff7faf04f430a75344035d96.tar.gz pyramid-32fca41e49875764ff7faf04f430a75344035d96.tar.bz2 pyramid-32fca41e49875764ff7faf04f430a75344035d96.zip | |
Apply suggestions from code review
Co-Authored-By: Éric Araujo <merwok@netwok.org>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/authorization.rst | 5 | ||||
| -rw-r--r-- | docs/api/security.rst | 15 |
2 files changed, 9 insertions, 11 deletions
diff --git a/docs/api/authorization.rst b/docs/api/authorization.rst index fac47490a..ec5dd4d36 100644 --- a/docs/api/authorization.rst +++ b/docs/api/authorization.rst @@ -17,14 +17,14 @@ Constants The special principal id named 'Everyone'. This principal id is granted to all requests. Its actual value is the string - 'system.Everyone'. + ``'system.Everyone'``. .. attribute:: Authenticated The special principal id named 'Authenticated'. This principal id is granted to all requests which contain any other non-Everyone principal id (according to the :term:`authentication policy`). - Its actual value is the string 'system.Authenticated'. + Its actual value is the string ``'system.Authenticated'``. .. attribute:: ALL_PERMISSIONS @@ -52,4 +52,3 @@ Return Values :members: msg .. automethod:: __new__ - diff --git a/docs/api/security.rst b/docs/api/security.rst index 3350f8207..7bfdbd0ad 100644 --- a/docs/api/security.rst +++ b/docs/api/security.rst @@ -28,13 +28,13 @@ Constants be executable by entirely anonymous users, regardless of the default permission, bypassing any :term:`authorization policy` that may be in effect. Its actual value is the string - '__no_permission_required__'. + ``'__no_permission_required__'``. .. attribute:: Everyone - The special principal id named 'Everyone'. This principal id is + The special principal id named ``Everyone``. This principal id is granted to all requests. Its actual value is the string - 'system.Everyone'. + ``'system.Everyone'``. .. deprecated:: 2.0 @@ -42,10 +42,10 @@ Constants .. attribute:: Authenticated - The special principal id named 'Authenticated'. This principal id + The special principal id named ``Authenticated``. This principal id is granted to all requests which contain any other non-Everyone principal id (according to the :term:`authentication policy`). - Its actual value is the string 'system.Authenticated'. + Its actual value is the string ``'system.Authenticated'``. .. deprecated:: 2.0 @@ -80,7 +80,7 @@ Return Values The ACE "action" (the first element in an ACE e.g. ``(Allow, Everyone, 'read')`` that means allow access. A sequence of ACEs makes up an - ACL. It is a string, and its actual value is "Allow". + ACL. It is a string, and its actual value is ``'Allow'``. .. deprecated:: 2.0 @@ -90,7 +90,7 @@ Return Values The ACE "action" (the first element in an ACE e.g. ``(Deny, 'george', 'read')`` that means deny access. A sequence of ACEs - makes up an ACL. It is a string, and its actual value is "Deny". + makes up an ACL. It is a string, and its actual value is ``'Deny'``. .. deprecated:: 2.0 @@ -123,4 +123,3 @@ Return Values Moved to :data:`pyramid.authorization.ACLAllowed`. .. automethod:: __new__ - |