Ticket #14746: http-doc-fixes.diff

docs/ref/request-response.txt

@@ -65 +65 @@
     .. versionadded:: 1.0
 
     A string representing the current encoding used to decode form submission
-    data (or ``None``, which means the ``DEFAULT_CHARSET`` setting is used).
-    You can write to this attribute to change the encoding used when accessing
-    the form data. Any subsequent attribute accesses (such as reading from
-    ``GET`` or ``POST``) will use the new ``encoding`` value.  Useful if you
-    know the form data is not in the ``DEFAULT_CHARSET`` encoding.
+    data (or ``None``, which means the :setting:`DEFAULT_CHARSET` setting is
+    used). You can write to this attribute to change the encoding used when
+    accessing the form data. Any subsequent attribute accesses (such as reading
+    from ``GET`` or ``POST``) will use the new ``encoding`` value.  Useful if
+    you know the form data is not in the :setting:`DEFAULT_CHARSET` encoding.
 
 .. attribute:: HttpRequest.GET
 
     A dictionary-like object containing all given HTTP GET parameters. See the
-    ``QueryDict`` documentation below.
+    :class:`QueryDict` documentation below.
 
 .. attribute:: HttpRequest.POST
 
     A dictionary-like object containing all given HTTP POST parameters. See the
-    ``QueryDict`` documentation below.
+    :class:`QueryDict` documentation below.
 
     It's possible that a request can come in via POST with an empty ``POST``
     dictionary -- if, say, a form is requested via the POST HTTP method but
@@ -110 +110 @@
 
     A dictionary-like object containing all uploaded files. Each key in
     ``FILES`` is the ``name`` from the ``<input type="file" name="" />``. Each
-    value in ``FILES`` is an ``UploadedFile`` object containing the following
-    attributes:
-
-        * ``read(num_bytes=None)`` -- Read a number of bytes from the file.
-        * ``name`` -- The name of the uploaded file.
-        * ``size`` -- The size, in bytes, of the uploaded file.
-        * ``chunks(chunk_size=None)`` -- A generator that yields sequential
-          chunks of data.
+    value in ``FILES`` is an :class:`UploadedFile` as described below.
 
     See :doc:`/topics/files` for more information.
 
@@ -130 +123 @@
 
     In previous versions of Django, ``request.FILES`` contained simple ``dict``
     objects representing uploaded files. This is no longer true -- files are
-    represented by ``UploadedFile`` objects as described below.
+    represented by :class:`UploadedFile` objects.
 
-    These ``UploadedFile`` objects will emulate the old-style ``dict``
-    interface, but this is deprecated and will be removed in the next release of
-    Django.
+    These :class:`UploadedFile` objects will emulate the old-style ``dict``
+    interface, but this is deprecated and will be removed in the next release
+    of Django.
 
 .. attribute:: HttpRequest.META
 
@@ -202 +195 @@
 
     Not defined by Django itself, but will be read if other code (e.g., a custom
     middleware class) sets it. When present, this will be used as the root
-    URLconf for the current request, overriding the ``ROOT_URLCONF`` setting.
-    See :ref:`how-django-processes-a-request` for details.
+    URLconf for the current request, overriding the :setting:`ROOT_URLCONF`
+    setting. See :ref:`how-django-processes-a-request` for details.
 
 Methods
 -------
@@ -300 +293 @@
             process(element)
 
 
+UploadedFile objects
+====================
+
+.. class:: UploadedFile
+
+
+Attributes
+----------
+
+.. attribute::  UploadedFile.name
+
+    The name of the uploaded file.
+
+.. attribute:: UploadedFile.size
+
+    The size, in bytes, of the uploaded file.
+
+Methods
+----------
+
+.. method:: UploadedFile.chunks(chunk_size=None)
+
+    Returns generator that yields sequential chunks of data.
+
+.. method:: UploadedFile.read(num_bytes=None)
+
+    Read a number of bytes from the file.
+
+
+
 QueryDict objects
------------------
+=================
 
 .. class:: QueryDict
 
@@ -449 +472 @@
 write is responsible for instantiating, populating and returning an
 :class:`HttpResponse`.
 
-The :class:`HttpResponse` class lives in the ``django.http`` module.
+The :class:`HttpResponse` class lives in the :mod:`django.http` module.
 
 Usage
 -----
@@ -529 +552 @@
 .. method:: HttpResponse.__init__(content='', mimetype=None, status=200, content_type=DEFAULT_CONTENT_TYPE)
 
     Instantiates an ``HttpResponse`` object with the given page content (a
-    string) and MIME type. The ``DEFAULT_CONTENT_TYPE`` is ``'text/html'``.
+    string) and MIME type. The :setting:`DEFAULT_CONTENT_TYPE` is
+    ``'text/html'``.
 
     ``content`` can be an iterator or a string. If it's an iterator, it should
     return strings, and those strings will be joined together to form the
@@ -545 +569 @@
     encoding, which makes it more than just a MIME type specification.
     If ``mimetype`` is specified (not ``None``), that value is used.
     Otherwise, ``content_type`` is used. If neither is given, the
-    ``DEFAULT_CONTENT_TYPE`` setting is used.
+    :setting:`DEFAULT_CONTENT_TYPE` setting is used.
 
 .. method:: HttpResponse.__setitem__(header, value)