Ticket #9607: add-extra-parameter-to-testing-doc.diff

docs/topics/testing.txt

@@ -478 +478 @@
     Once you have a ``Client`` instance, you can call any of the following
     methods:
 
-    .. method:: Client.get(path, data={})
+    .. method:: Client.get(path, data={}, **extra)
 
         Makes a GET request on the provided ``path`` and returns a ``Response``
         object, which is documented below.
@@ -493 +493 @@
 
             /customers/details/?name=fred&age=7
 
+        The ``extra`` keyword arguments parameter can be used to specify 
+        headers to be sent in the request. For example::
+        
+            >>> c = Client()
+            >>> c.get('/customers/details/', {'name': 'fred', 'age': 7}, 
+            ...       HTTP_X_REQUESTED_WITH='XMLHttpRequest')
+
+        ...this will send the HTTP header ``HTTP_X_REQUESTED_WITH`` to the
+        details view, which is a good way to test code paths that use the
+        :meth:`django.http.HttpRequest.is_ajax()` method.
+
         .. versionadded:: development
 
         If you already have the GET arguments in URL-encoded form, you can
@@ -505 +516 @@
         If you provide URL both an encoded GET data and a data argument,
         the data argument will take precedence.
 
-    .. method:: Client.post(path, data={}, content_type=MULTIPART_CONTENT)
+    .. method:: Client.post(path, data={}, content_type=MULTIPART_CONTENT, **extra)
 
         Makes a POST request on the provided ``path`` and returns a
         ``Response`` object, which is documented below.
@@ -568 +579 @@
         to retrieve the username and password, and could interrogate request.GET
         to determine if the user was a visitor.
 
-    .. method:: Client.head(path, data={})
+    .. method:: Client.head(path, data={}, **extra)
 
         .. versionadded:: development
 
@@ -576 +587 @@
         object. Useful for testing RESTful interfaces. Acts just like
         :meth:`Client.get` except it does not return a message body.
 
-    .. method:: Client.options(path, data={})
+    .. method:: Client.options(path, data={}, **extra)
 
         .. versionadded:: development
 
         Makes an OPTIONS request on the provided ``path`` and returns a
         ``Response`` object. Useful for testing RESTful interfaces.
 
-    .. method:: Client.put(path, data={}, content_type=MULTIPART_CONTENT)
+    .. method:: Client.put(path, data={}, content_type=MULTIPART_CONTENT, **extra)
 
         .. versionadded:: development
 
@@ -591 +602 @@
         ``Response`` object. Useful for testing RESTful interfaces. Acts just
         like :meth:`Client.post` except with the PUT request method.
 
-    .. method:: Client.delete(path)
+    .. method:: Client.delete(path, **extra)
 
         .. versionadded:: development