aboutsummaryrefslogtreecommitdiffstats
path: root/djangorestframework/emitters.py
diff options
context:
space:
mode:
authortom christie tom@tomchristie.com2011-02-19 13:12:35 +0000
committertom christie tom@tomchristie.com2011-02-19 13:12:35 +0000
commite4fff6ea6e5422af23c324897ed1cff8f8a6e903 (patch)
tree030c0d0a02e25ffdef43781fbc815dbce48dd16d /djangorestframework/emitters.py
parent57b3a372f2122d022f9d6f43818e5fe9d318ce03 (diff)
downloaddjango-rest-framework-e4fff6ea6e5422af23c324897ed1cff8f8a6e903.tar.bz2
Clean up the docs
Diffstat (limited to 'djangorestframework/emitters.py')
-rw-r--r--djangorestframework/emitters.py7
1 files changed, 7 insertions, 0 deletions
diff --git a/djangorestframework/emitters.py b/djangorestframework/emitters.py
index 6e101e86..be1d7ef3 100644
--- a/djangorestframework/emitters.py
+++ b/djangorestframework/emitters.py
@@ -32,6 +32,12 @@ _MSIE_USER_AGENT = re.compile(r'^Mozilla/[0-9]+\.[0-9]+ \([^)]*; MSIE [0-9]+\.[0
class EmitterMixin(object):
+ """Adds behaviour for pluggable Emitters to a :class:`.Resource` or Django :class:`View`. class.
+
+ Default behaviour is to use standard HTTP Accept header content negotiation.
+ Also supports overidding the content type by specifying an _accept= parameter in the URL.
+ Ignores Accept headers from Internet Explorer user agents and uses a sensible browser Accept header instead."""
+
ACCEPT_QUERY_PARAM = '_accept' # Allow override of Accept header in URL query params
REWRITE_IE_ACCEPT_HEADER = True
@@ -40,6 +46,7 @@ class EmitterMixin(object):
emitters = ()
def emit(self, response):
+ """Takes a :class:`Response` object and returns a Django :class:`HttpResponse`."""
self.response = response
try: