diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/authenticators.rst | 4 | ||||
| -rw-r--r-- | docs/emitters.rst | 8 |
2 files changed, 8 insertions, 4 deletions
diff --git a/docs/authenticators.rst b/docs/authenticators.rst index e8cc9e51..a2d6112e 100644 --- a/docs/authenticators.rst +++ b/docs/authenticators.rst @@ -3,7 +3,7 @@ .. module:: authenticators -The authenticators module provides a standard set of authentication methods that can be plugged in to a :class:`Resource`, as well as providing a template by which to write custom authentication methods. +The authenticators module provides a standard set of authentication methods that can be plugged in to a :class:`.Resource`, as well as providing a template by which to write custom authentication methods. The base class -------------- @@ -18,7 +18,7 @@ All authenticators must subclass the :class:`BaseAuthenticator` class and overri The default permission checking on :class:`.Resource` will use the allowed_methods attribute for permissions if the authentication context is not None, and use anon_allowed_methods otherwise. - The authentication context is passed to the method calls (eg :meth:`.Resource.get`, :meth:`.Resource.post` etc...) in order to allow them to apply any more fine grained permission checking at the point the response is being generated. + The authentication context is passed to the handler calls (eg :meth:`.Resource.get`, :meth:`.Resource.post` etc...) in order to allow them to apply any more fine grained permission checking at the point the response is being generated. This function must be overridden to be implemented. diff --git a/docs/emitters.rst b/docs/emitters.rst index fc96e71f..fcea6151 100644 --- a/docs/emitters.rst +++ b/docs/emitters.rst @@ -1,5 +1,9 @@ -Emitters -======== +:mod:`emitters` +=============== + +.. module:: emitters + +The emitters module provides a set of emitters that can be plugged in to a :class:`.Resource`. An emitter is responsible for taking the output of a and serializing it to a given media type. A :class:`.Resource` can have a number of emitters, allow the same content to be serialized in a number of different formats depending on the requesting client's preferences, as specified in the HTTP Request's Accept header. .. automodule:: emitters :members: |