aboutsummaryrefslogtreecommitdiffstats
path: root/djangorestframework/renderers.py
diff options
context:
space:
mode:
authorTom Christie2011-05-19 08:49:57 +0100
committerTom Christie2011-05-19 08:49:57 +0100
commite7f8c06dbbbc9e4ae91327ee02cd8147777b17e2 (patch)
treed2a0788753c03eb438ac44d97520b132be0d9097 /djangorestframework/renderers.py
parent8c3280f9c0d73c4e2536f1d757ad457b4a8f1de7 (diff)
parent92c015e0495b7cf39b0d0387fe6d376812a9ebef (diff)
downloaddjango-rest-framework-e7f8c06dbbbc9e4ae91327ee02cd8147777b17e2.tar.bz2
Merge in marko's doc markup
Diffstat (limited to 'djangorestframework/renderers.py')
-rw-r--r--djangorestframework/renderers.py10
1 files changed, 5 insertions, 5 deletions
diff --git a/djangorestframework/renderers.py b/djangorestframework/renderers.py
index 112736d2..3e59511c 100644
--- a/djangorestframework/renderers.py
+++ b/djangorestframework/renderers.py
@@ -36,8 +36,8 @@ __all__ = (
class BaseRenderer(object):
"""
- All renderers must extend this class, set the media_type attribute,
- and override the render() function.
+ All renderers must extend this class, set the :attr:`media_type` attribute,
+ and override the :meth:`render` method.
"""
media_type = None
@@ -51,7 +51,7 @@ class BaseRenderer(object):
The requested media type is also passed to this method,
as it may contain parameters relevant to how the parser
should render the output.
- EG: 'application/json; indent=4'
+ EG: ``application/json; indent=4``
By default render simply returns the output as-is.
Override this method to provide for other behavior.
@@ -102,8 +102,8 @@ class TemplateRenderer(BaseRenderer):
A Base class provided for convenience.
Render the object simply by using the given template.
- To create a template renderer, subclass this, and set
- the ``media_type`` and ``template`` attributes
+ To create a template renderer, subclass this class, and set
+ the :attr:`media_type` and `:attr:template` attributes.
"""
media_type = None
template = None