summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBerker Peksag <berker.peksag@gmail.com>2014-11-03 12:30:48 +0200
committerTim Graham <timograham@gmail.com>2014-11-03 21:40:26 -0500
commit5c517ec21839358249c6f17611abbf84661fb200 (patch)
tree1afeb511ca0dc8ab5e969af6b07aa2dd9ea3ce60 /docs
parenta71a2ea756673cd3c7a2c5125fa7e7f334b05475 (diff)
Fixed versionchanged indentation in docs/.
Diffstat (limited to 'docs')
-rw-r--r--docs/howto/windows.txt4
-rw-r--r--docs/ref/contrib/sites.txt10
-rw-r--r--docs/ref/files/storage.txt19
-rw-r--r--docs/ref/forms/formsets.txt2
-rw-r--r--docs/ref/models/instances.txt8
-rw-r--r--docs/ref/models/options.txt4
-rw-r--r--docs/ref/models/querysets.txt10
-rw-r--r--docs/ref/templates/builtins.txt6
-rw-r--r--docs/topics/email.txt14
-rw-r--r--docs/topics/forms/index.txt6
-rw-r--r--docs/topics/http/sessions.txt4
-rw-r--r--docs/topics/serialization.txt12
12 files changed, 53 insertions, 46 deletions
diff --git a/docs/howto/windows.txt b/docs/howto/windows.txt
index f81901371e..aee243f923 100644
--- a/docs/howto/windows.txt
+++ b/docs/howto/windows.txt
@@ -64,8 +64,8 @@ by executing ``django-admin --version`` in the command prompt.
.. versionchanged:: 1.7
- In Django 1.7, a ``.exe`` has been introduced, so just use
- ``django-admin`` in place of ``django-admin.py`` in the command prompt.
+ In Django 1.7, a ``.exe`` has been introduced, so just use
+ ``django-admin`` in place of ``django-admin.py`` in the command prompt.
See :ref:`database-installation` for information on database installation
with Django.
diff --git a/docs/ref/contrib/sites.txt b/docs/ref/contrib/sites.txt
index acfd7f92f7..b8dc7ef9ca 100644
--- a/docs/ref/contrib/sites.txt
+++ b/docs/ref/contrib/sites.txt
@@ -474,7 +474,7 @@ a fallback when the database-backed sites framework is not available.
.. versionchanged:: 1.7
- This class used to be defined in ``django.contrib.sites.models``.
+ This class used to be defined in ``django.contrib.sites.models``.
A :class:`~django.contrib.sites.requests.RequestSite` object has a similar
interface to a normal :class:`~django.contrib.sites.models.Site` object,
@@ -500,10 +500,10 @@ Finally, to avoid repetitive fallback code, the framework provides a
.. versionchanged:: 1.7
- This function used to be defined in ``django.contrib.sites.models``.
+ This function used to be defined in ``django.contrib.sites.models``.
.. versionchanged:: 1.8
- This function will now lookup the current site based on
- :meth:`request.get_host() <django.http.HttpRequest.get_host>` if the
- :setting:`SITE_ID` setting is not defined.
+ This function will now lookup the current site based on
+ :meth:`request.get_host() <django.http.HttpRequest.get_host>` if the
+ :setting:`SITE_ID` setting is not defined.
diff --git a/docs/ref/files/storage.txt b/docs/ref/files/storage.txt
index f2578e7f63..1d84254f41 100644
--- a/docs/ref/files/storage.txt
+++ b/docs/ref/files/storage.txt
@@ -112,17 +112,18 @@ The Storage Class
available for new content to be written to on the target storage
system.
- .. versionchanged:: 1.7
+ If a file with ``name`` already exists, an underscore plus a random
+ 7 character alphanumeric string is appended to the filename before
+ the extension.
- If a file with ``name`` already exists, an underscore plus a random 7
- character alphanumeric string is appended to the filename before the
- extension.
+ .. versionchanged:: 1.7
- Previously, an underscore followed by a number (e.g. ``"_1"``, ``"_2"``,
- etc.) was appended to the filename until an available name in the
- destination directory was found. A malicious user could exploit this
- deterministic algorithm to create a denial-of-service attack. This
- change was also made in Django 1.6.6, 1.5.9, and 1.4.14.
+ Previously, an underscore followed by a number (e.g. ``"_1"``,
+ ``"_2"``, etc.) was appended to the filename until an available
+ name in the destination directory was found. A malicious user could
+ exploit this deterministic algorithm to create a denial-of-service
+ attack. This change was also made in Django 1.6.6, 1.5.9, and
+ 1.4.14.
.. method:: get_valid_name(name)
diff --git a/docs/ref/forms/formsets.txt b/docs/ref/forms/formsets.txt
index f613b87201..a4143e5de4 100644
--- a/docs/ref/forms/formsets.txt
+++ b/docs/ref/forms/formsets.txt
@@ -16,4 +16,4 @@ Formset API reference. For introductory material about formsets, see the
.. versionchanged:: 1.7
- The ``min_num`` and ``validate_min`` parameters were added.
+ The ``min_num`` and ``validate_min`` parameters were added.
diff --git a/docs/ref/models/instances.txt b/docs/ref/models/instances.txt
index de0c25f831..21c4c86c13 100644
--- a/docs/ref/models/instances.txt
+++ b/docs/ref/models/instances.txt
@@ -604,8 +604,8 @@ For example::
.. versionchanged:: 1.7
- In previous versions only instances of the exact same class and same
- primary key value were considered equal.
+ In previous versions only instances of the exact same class and same
+ primary key value were considered equal.
``__hash__``
------------
@@ -621,8 +621,8 @@ in Python`_).
.. versionchanged:: 1.7
- In previous versions instance's without primary key value were
- hashable.
+ In previous versions instance's without primary key value were
+ hashable.
.. _is forbidden in Python: http://docs.python.org/reference/datamodel.html#object.__hash__
diff --git a/docs/ref/models/options.txt b/docs/ref/models/options.txt
index 6cb2e34bd9..8c6cd4f698 100644
--- a/docs/ref/models/options.txt
+++ b/docs/ref/models/options.txt
@@ -338,8 +338,8 @@ Django quotes column and table names behind the scenes.
.. versionchanged:: 1.7
- The ``ValidationError`` raised during model validation when the
- constraint is violated has the ``unique_together`` error code.
+ The ``ValidationError`` raised during model validation when the
+ constraint is violated has the ``unique_together`` error code.
``index_together``
------------------
diff --git a/docs/ref/models/querysets.txt b/docs/ref/models/querysets.txt
index 9187dffdba..77f933de6a 100644
--- a/docs/ref/models/querysets.txt
+++ b/docs/ref/models/querysets.txt
@@ -819,12 +819,14 @@ If you need to clear the list of related fields added by past calls of
>>> without_relations = queryset.select_related(None)
+Chaining ``select_related`` calls works in a similar way to other methods -
+that is that ``select_related('foo', 'bar')`` is equivalent to
+``select_related('foo').select_related('bar')``.
+
.. versionchanged:: 1.7
-Chaining ``select_related`` calls now works in a similar way to other methods -
-that is that ``select_related('foo', 'bar')`` is equivalent to
-``select_related('foo').select_related('bar')``. Previously the latter would
-have been equivalent to ``select_related('bar')``.
+ Previously the latter would have been equivalent to
+ ``select_related('bar')``.
prefetch_related
~~~~~~~~~~~~~~~~
diff --git a/docs/ref/templates/builtins.txt b/docs/ref/templates/builtins.txt
index fe9127bea5..2b3d48d90e 100644
--- a/docs/ref/templates/builtins.txt
+++ b/docs/ref/templates/builtins.txt
@@ -1142,14 +1142,16 @@ If ``this_value`` is 175, ``max_value`` is 200, and ``max_width`` is 100, the
image in the above example will be 88 pixels wide
(because 175/200 = .875; .875 * 100 = 87.5 which is rounded up to 88).
-.. versionchanged:: 1.7
-
In some cases you might want to capture the result of ``widthratio`` in a
variable. It can be useful, for instance, in a :ttag:`blocktrans` like this::
{% widthratio this_value max_value max_width as width %}
{% blocktrans %}The width is: {{ width }}{% endblocktrans %}
+.. versionchanged:: 1.7
+
+ The ability to use "as" with this tag like in the example above was added.
+
.. templatetag:: with
with
diff --git a/docs/topics/email.txt b/docs/topics/email.txt
index 7303a6fe6f..c49e9ed9ee 100644
--- a/docs/topics/email.txt
+++ b/docs/topics/email.txt
@@ -327,15 +327,15 @@ The class has the following methods:
.. versionchanged:: 1.7
- If you specify a ``mimetype`` of ``message/rfc822``, it will also accept
- :class:`django.core.mail.EmailMessage` and :py:class:`email.message.Message`.
+ If you specify a ``mimetype`` of ``message/rfc822``, it will also accept
+ :class:`django.core.mail.EmailMessage` and :py:class:`email.message.Message`.
- In addition, ``message/rfc822`` attachments will no longer be
- base64-encoded in violation of :rfc:`2046#section-5.2.1`, which can cause
- issues with displaying the attachments in `Evolution`__ and `Thunderbird`__.
+ In addition, ``message/rfc822`` attachments will no longer be
+ base64-encoded in violation of :rfc:`2046#section-5.2.1`, which can cause
+ issues with displaying the attachments in `Evolution`__ and `Thunderbird`__.
- __ https://bugzilla.gnome.org/show_bug.cgi?id=651197
- __ https://bugzilla.mozilla.org/show_bug.cgi?id=333880
+ __ https://bugzilla.gnome.org/show_bug.cgi?id=651197
+ __ https://bugzilla.mozilla.org/show_bug.cgi?id=333880
* ``attach_file()`` creates a new attachment using a file from your
filesystem. Call it with the path of the file to attach and, optionally,
diff --git a/docs/topics/forms/index.txt b/docs/topics/forms/index.txt
index c20acde52f..473285d37e 100644
--- a/docs/topics/forms/index.txt
+++ b/docs/topics/forms/index.txt
@@ -578,8 +578,6 @@ over them:
</ol>
{% endif %}
-.. versionchanged:: 1.8
-
Non-field errors (and/or hidden field errors that are rendered at the top of
the form when using helpers like ``form.as_p()``) will be rendered with an
additional class of ``nonfield`` to help distinguish them from field-specific
@@ -591,6 +589,10 @@ errors. For example, ``{{ form.non_field_errors }}`` would look like:
<li>Generic validation error</li>
</ul>
+.. versionchanged:: 1.8
+
+ The "nonfield" class as described in the example above was added.
+
See :doc:`/ref/forms/api` for more on errors, styling, and working with form
attributes in templates.
diff --git a/docs/topics/http/sessions.txt b/docs/topics/http/sessions.txt
index 32d26f003c..46c273726b 100644
--- a/docs/topics/http/sessions.txt
+++ b/docs/topics/http/sessions.txt
@@ -97,8 +97,8 @@ configuration instructions for the `using database-backed sessions`_.
.. versionchanged:: 1.7
-Before version 1.7, the ``cached_db`` backend always used the ``default`` cache
-rather than the :setting:`SESSION_CACHE_ALIAS`.
+ Before version 1.7, the ``cached_db`` backend always used the ``default``
+ cache rather than the :setting:`SESSION_CACHE_ALIAS`.
Using file-based sessions
-------------------------
diff --git a/docs/topics/serialization.txt b/docs/topics/serialization.txt
index 11076c8027..8ddf6a6b57 100644
--- a/docs/topics/serialization.txt
+++ b/docs/topics/serialization.txt
@@ -476,12 +476,12 @@ line flags to generate natural keys.
.. versionchanged:: 1.7
-Previously there was only a ``use_natural_keys`` argument for
-``serializers.serialize()`` and the `-n` or `--natural` command line flags.
-These have been deprecated in favor of the ``use_natural_foreign_keys`` and
-``use_natural_primary_keys`` arguments and the corresponding
-:djadminopt:`--natural-foreign` and :djadminopt:`--natural-primary` options
-for :djadmin:`dumpdata`.
+ Previously there was only a ``use_natural_keys`` argument for
+ ``serializers.serialize()`` and the `-n` or `--natural` command line flags.
+ These have been deprecated in favor of the ``use_natural_foreign_keys`` and
+ ``use_natural_primary_keys`` arguments and the corresponding
+ :djadminopt:`--natural-foreign` and :djadminopt:`--natural-primary` options
+ for :djadmin:`dumpdata`.
The original argument and command line flags remain for backwards
compatibility and map to the new ``use_natural_foreign_keys`` argument and