innov
/
django1
1
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity

Corrected indentation of JsonResponse docs.

This commit is contained in:
Tim Graham 2015-08-12 10:26:59 -04:00
parent b7508896fb
commit 290145e661
1 changed files with 16 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/ref/request-response.txt
View File

@ -912,29 +912,27 @@ types of HTTP responses. Like ``HttpResponse``, these subclasses live in
JsonResponse objects
====================
.. class:: JsonResponse
.. class:: JsonResponse(data, encoder=DjangoJSONEncoder, safe=True, **kwargs)
.. method:: JsonResponse.__init__(data, encoder=DjangoJSONEncoder, safe=True, **kwargs)
An :class:`HttpResponse` subclass that helps to create a JSON-encoded
response. It inherits most behavior from its superclass with a couple
differences:
An :class:`HttpResponse` subclass that helps to create a JSON-encoded
response. It inherits most behavior from its superclass with a couple
differences:
Its default ``Content-Type`` header is set to ``application/json``.
Its default ``Content-Type`` header is set to ``application/json``.
The first parameter, ``data``, should be a ``dict`` instance. If the
``safe`` parameter is set to ``False`` (see below) it can be any
JSON-serializable object.
The first parameter, ``data``, should be a ``dict`` instance. If the ``safe``
parameter is set to ``False`` (see below) it can be any JSON-serializable
object.
The ``encoder``, which defaults to
``django.core.serializers.json.DjangoJSONEncoder``, will be used to
serialize the data. See :ref:`JSON serialization
<serialization-formats-json>` for more details about this serializer.
The ``encoder``, which defaults to
``django.core.serializers.json.DjangoJSONEncoder``, will be used to
serialize the data. See :ref:`JSON serialization
<serialization-formats-json>` for more details about this serializer.
The ``safe`` boolean parameter defaults to ``True``. If it's set to ``False``,
any object can be passed for serialization (otherwise only ``dict`` instances
are allowed). If ``safe`` is ``True`` and a non-``dict`` object is passed as
the first argument, a :exc:`TypeError` will be raised.
The ``safe`` boolean parameter defaults to ``True``. If it's set to
``False``, any object can be passed for serialization (otherwise only
``dict`` instances are allowed). If ``safe`` is ``True`` and a non-``dict``
object is passed as the first argument, a :exc:`TypeError` will be raised.
Usage
-----