Update documentation

Author: tomchristie

api-guide/fields/index.html

@@ -576,10 +576,7 @@ <h3 id="myModalLabel">Documentation search</h3>
 
 
 
-            <hr />
-<p><strong>Note</strong>: This is the documentation for the <strong>version 3.0</strong> of REST framework. Documentation for <a href="http://tomchristie.github.io/rest-framework-2-docs/">version 2.4</a> is also available.</p>
-<hr />
-<h1 id="serializer-fields">Serializer fields</h1>
+            <h1 id="serializer-fields">Serializer fields</h1>
 <blockquote>
 <p>Each field in a Form class is responsible not only for validating data, but also for "cleaning" it &mdash; normalizing it to a consistent format.</p>
 <p>&mdash; <a href="https://docs.djangoproject.com/en/dev/ref/forms/api/#django.forms.Form.cleaned_data">Django documentation</a></p>

api-guide/generic-views/index.html

@@ -496,10 +496,7 @@ <h3 id="myModalLabel">Documentation search</h3>
 
 
 
-            <hr />
-<p><strong>Note</strong>: This is the documentation for the <strong>version 3.0</strong> of REST framework. Documentation for <a href="http://tomchristie.github.io/rest-framework-2-docs/">version 2.4</a> is also available.</p>
-<hr />
-<h1 id="generic-views">Generic views</h1>
+            <h1 id="generic-views">Generic views</h1>
 <blockquote>
 <p>Django’s generic views... were developed as a shortcut for common usage patterns... They take certain common idioms and patterns found in view development and abstract them so that you can quickly write common views of data without having to repeat yourself.</p>
 <p>&mdash; <a href="https://docs.djangoproject.com/en/dev/ref/class-based-views/#base-vs-generic-views">Django Documentation</a></p>

api-guide/metadata/index.html

@@ -388,10 +388,7 @@ <h3 id="myModalLabel">Documentation search</h3>
 
 
 
-            <hr />
-<p><strong>Note</strong>: This is the documentation for the <strong>version 3.0</strong> of REST framework. Documentation for <a href="http://tomchristie.github.io/rest-framework-2-docs/">version 2.4</a> is also available.</p>
-<hr />
-<h1 id="metadata">Metadata</h1>
+            <h1 id="metadata">Metadata</h1>
 <blockquote>
 <p>[The <code>OPTIONS</code>] method allows a client to determine the options and/or requirements associated with a resource, or the capabilities of a server, without implying a resource action or initiating a resource retrieval.</p>
 <p>&mdash; <a href="http://tools.ietf.org/html/rfc7231#section-4.3.7">RFC7231, Section 4.3.7.</a></p>

api-guide/pagination/index.html

@@ -502,18 +502,18 @@ <h2 id="pagenumberpagination">PageNumberPagination</h2>
 }
 </code></pre>
 <h4 id="setup">Setup</h4>
-<p>To enable the <code>PageNumberPagination</code> style globally, use the following configuration, modifying the <code>DEFAULT_PAGE_SIZE</code> as desired:</p>
+<p>To enable the <code>PageNumberPagination</code> style globally, use the following configuration, modifying the <code>PAGE_SIZE</code> as desired:</p>
 <pre><code>REST_FRAMEWORK = {
     'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
-    'DEFAULT_PAGE_SIZE': 100
+    'PAGE_SIZE': 100
 }
 </code></pre>
 <p>On <code>GenericAPIView</code> subclasses you may also set the <code>pagination_class</code> attribute to select <code>PageNumberPagination</code> on a per-view basis.</p>
 <h4 id="configuration">Configuration</h4>
 <p>The <code>PageNumberPagination</code> class includes a number of attributes that may be overridden to modify the pagination style.</p>
 <p>To set these attributes you should override the <code>PageNumberPagination</code> class, and then enable your custom pagination class as above.</p>
 <ul>
-<li><code>page_size</code> - A numeric value indicating the page size. If set, this overrides the <code>DEFAULT_PAGE_SIZE</code> setting. Defaults to the same value as the <code>DEFAULT_PAGE_SIZE</code> settings key.</li>
+<li><code>page_size</code> - A numeric value indicating the page size. If set, this overrides the <code>PAGE_SIZE</code> setting. Defaults to the same value as the <code>PAGE_SIZE</code> settings key.</li>
 <li><code>page_query_param</code> - A string value indicating the name of the query parameter to use for the pagination control.</li>
 <li><code>page_size_query_param</code> - If set, this is a string value indicating the name of a query parameter that allows the client to set the page size on a per-request basis. Defaults to <code>None</code>, indicating that the client may not control the requested page size.</li>
 <li><code>max_page_size</code> - If set, this is a numeric value indicating the maximum allowable requested page size. This attribute is only valid if <code>page_size_query_param</code> is also set.</li>
@@ -544,13 +544,13 @@ <h4 id="setup_1">Setup</h4>
     'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination'
 }
 </code></pre>
-<p>Optionally, you may also set a <code>DEFAULT_PAGE_SIZE</code> key. If the <code>DEFAULT_PAGE_SIZE</code> parameter is also used then the <code>limit</code> query parameter will be optional, and may be omitted by the client.</p>
+<p>Optionally, you may also set a <code>PAGE_SIZE</code> key. If the <code>PAGE_SIZE</code> parameter is also used then the <code>limit</code> query parameter will be optional, and may be omitted by the client.</p>
 <p>On <code>GenericAPIView</code> subclasses you may also set the <code>pagination_class</code> attribute to select <code>LimitOffsetPagination</code> on a per-view basis.</p>
 <h4 id="configuration_1">Configuration</h4>
 <p>The <code>LimitOffsetPagination</code> class includes a number of attributes that may be overridden to modify the pagination style.</p>
 <p>To set these attributes you should override the <code>LimitOffsetPagination</code> class, and then enable your custom pagination class as above.</p>
 <ul>
-<li><code>default_limit</code> - A numeric value indicating the limit to use if one is not provided by the client in a query parameter. Defaults to the same value as the <code>DEFAULT_PAGE_SIZE</code> settings key.</li>
+<li><code>default_limit</code> - A numeric value indicating the limit to use if one is not provided by the client in a query parameter. Defaults to the same value as the <code>PAGE_SIZE</code> settings key.</li>
 <li><code>limit_query_param</code> - A string value indicating the name of the "limit" query parameter. Defaults to <code>'limit'</code>.</li>
 <li><code>offset_query_param</code> - A string value indicating the name of the "offset" query parameter. Defaults to <code>'offset'</code>.</li>
 <li><code>max_limit</code> - If set this is a numeric value indicating the maximum allowable limit that may be requested by the client. Defaults to <code>None</code>.</li>
@@ -566,7 +566,7 @@ <h2 id="cursorpagination">CursorPagination</h2>
 <li>Supports usage with very large datasets. With extremely large datasets pagination using offset-based pagination styles may become inefficient or unusable. Cursor based pagination schemes instead have fixed-time properties, and do not slow down as the dataset size increases.</li>
 </ul>
 <h4 id="details-and-limitations">Details and limitations</h4>
-<p>Proper use of cursor based pagination a little attention to detail. You'll need to think about what ordering you want the scheme to be applied against. The default is to order by <code>"-created"</code>. This assumes that <strong>there must be a 'created' timestamp field</strong> on the model instances, and will present a "timeline" style paginated view, with the most recently added items first.</p>
+<p>Proper use of cursor based pagination requires a little attention to detail. You'll need to think about what ordering you want the scheme to be applied against. The default is to order by <code>"-created"</code>. This assumes that <strong>there must be a 'created' timestamp field</strong> on the model instances, and will present a "timeline" style paginated view, with the most recently added items first.</p>
 <p>You can modify the ordering by overriding the <code>'ordering'</code> attribute on the pagination class, or by using the <code>OrderingFilter</code> filter class together with <code>CursorPagination</code>. When used with <code>OrderingFilter</code> you should strongly consider restricting the fields that the user may order by.</p>
 <p>Proper usage of cursor pagination should have an ordering field that satisfies the following:</p>
 <ul>
@@ -578,10 +578,10 @@ <h4 id="details-and-limitations">Details and limitations</h4>
 <p>Using an ordering field that does not satisfy these constraints will generally still work, but you'll be loosing some of the benefits of cursor pagination.</p>
 <p>For more technical details on the implementation we use for cursor pagination, the <a href="http://cramer.io/2011/03/08/building-cursors-for-the-disqus-api/">"Building cursors for the Disqus API"</a> blog post gives a good overview of the basic approach.</p>
 <h4 id="setup_2">Setup</h4>
-<p>To enable the <code>CursorPagination</code> style globally, use the following configuration, modifying the <code>DEFAULT_PAGE_SIZE</code> as desired:</p>
+<p>To enable the <code>CursorPagination</code> style globally, use the following configuration, modifying the <code>PAGE_SIZE</code> as desired:</p>
 <pre><code>REST_FRAMEWORK = {
     'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.CursorPagination',
-    'DEFAULT_PAGE_SIZE': 100
+    'PAGE_SIZE': 100
 }
 </code></pre>
 <p>On <code>GenericAPIView</code> subclasses you may also set the <code>pagination_class</code> attribute to select <code>CursorPagination</code> on a per-view basis.</p>

api-guide/relations/index.html

@@ -464,10 +464,7 @@ <h3 id="myModalLabel">Documentation search</h3>
 
 
 
-            <hr />
-<p><strong>Note</strong>: This is the documentation for the <strong>version 3.0</strong> of REST framework. Documentation for <a href="http://tomchristie.github.io/rest-framework-2-docs/">version 2.4</a> is also available.</p>
-<hr />
-<h1 id="serializer-relations">Serializer relations</h1>
+            <h1 id="serializer-relations">Serializer relations</h1>
 <blockquote>
 <p>Bad programmers worry about the code.
 Good programmers worry about data structures and their relationships.</p>

api-guide/requests/index.html

@@ -460,10 +460,7 @@ <h3 id="myModalLabel">Documentation search</h3>
 
 
 
-            <hr />
-<p><strong>Note</strong>: This is the documentation for the <strong>version 3.0</strong> of REST framework. Documentation for <a href="http://tomchristie.github.io/rest-framework-2-docs/">version 2.4</a> is also available.</p>
-<hr />
-<h1 id="requests">Requests</h1>
+            <h1 id="requests">Requests</h1>
 <blockquote>
 <p>If you're doing REST-based web service stuff ... you should ignore request.POST.</p>
 <p>&mdash; Malcom Tredinnick, <a href="https://groups.google.com/d/topic/django-developers/dxI4qVzrBY4/discussion">Django developers group</a></p>

api-guide/serializers/index.html

@@ -552,10 +552,7 @@ <h3 id="myModalLabel">Documentation search</h3>
 
 
 
-            <hr />
-<p><strong>Note</strong>: This is the documentation for the <strong>version 3.0</strong> of REST framework. Documentation for <a href="http://tomchristie.github.io/rest-framework-2-docs/">version 2.4</a> is also available.</p>
-<hr />
-<h1 id="serializers">Serializers</h1>
+            <h1 id="serializers">Serializers</h1>
 <blockquote>
 <p>Expanding the usefulness of the serializers is something that we would
 like to address.  However, it's not a trivial problem, and it

api-guide/validators/index.html

@@ -424,10 +424,7 @@ <h3 id="myModalLabel">Documentation search</h3>
 
 
 
-            <hr />
-<p><strong>Note</strong>: This is the documentation for the <strong>version 3.0</strong> of REST framework. Documentation for <a href="http://tomchristie.github.io/rest-framework-2-docs/">version 2.4</a> is also available.</p>
-<hr />
-<h1 id="validators">Validators</h1>
+            <h1 id="validators">Validators</h1>
 <blockquote>
 <p>Validators can be useful for re-using validation logic between different types of fields.</p>
 <p>&mdash; <a href="https://docs.djangoproject.com/en/dev/ref/validators/">Django documentation</a></p>
@@ -446,7 +443,7 @@ <h2 id="validation-in-rest-framework">Validation in REST framework</h2>
 <h4 id="example">Example</h4>
 <p>As an example of how REST framework uses explicit validation, we'll take a simple model class that has a field with a uniqueness constraint.</p>
 <pre><code>class CustomerReportRecord(models.Model):
-    time_raised = models.DateTimeField(default=timezone.now, editable=False) 
+    time_raised = models.DateTimeField(default=timezone.now, editable=False)
     reference = models.CharField(unique=True, max_length=20)
     description = models.TextField()
 </code></pre>
@@ -455,7 +452,7 @@ <h4 id="example">Example</h4>
     class Meta:
         model = CustomerReportRecord
 </code></pre>
-<p>If we open up the Django shell using <code>manage.py shell</code> we can now </p>
+<p>If we open up the Django shell using <code>manage.py shell</code> we can now</p>
 <pre><code>&gt;&gt;&gt; from project.example.serializers import CustomerReportSerializer
 &gt;&gt;&gt; serializer = CustomerReportSerializer()
 &gt;&gt;&gt; print(repr(serializer))

index.html

@@ -461,8 +461,8 @@ <h3 id="myModalLabel">Documentation search</h3>
 </p>
 
 <hr />
-<p><strong>Note</strong>: This is the documentation for the <strong>version 3.0</strong> of REST framework. Documentation for <a href="http://tomchristie.github.io/rest-framework-2-docs/">version 2.4</a> is also available.</p>
-<p>For more details see the <a href="topics/3.0-announcement/">3.0 release notes</a>.</p>
+<p><strong>Note</strong>: This is the documentation for the <strong>version 3.1</strong> of REST framework. Documentation for <a href="http://tomchristie.github.io/rest-framework-2-docs/">version 2.4</a> is also available.</p>
+<p>For more details see the <a href="topics/3.1-announcement/">3.1 release notes</a>.</p>
 <hr />
 <p>
 <h1 style="position: absolute;