Permalink
Browse files

Removed versionadded/changed annotations dating back to 1.4.

  • Loading branch information...
aaugustin committed Dec 26, 2012
1 parent ef017a5 commit 7ee7599ab389129c539f62b8295fcf1128defa13
Showing with 60 additions and 410 deletions.
  1. +6 −18 docs/howto/custom-template-tags.txt
  2. +0 −2 docs/howto/deployment/wsgi/index.txt
  3. +5 −11 docs/howto/error-reporting.txt
  4. +0 −5 docs/ref/class-based-views/mixins-editing.txt
  5. +0 −4 docs/ref/class-based-views/mixins-single-object.txt
  6. +0 −3 docs/ref/clickjacking.txt
  7. +3 −42 docs/ref/contrib/admin/index.txt
  8. +0 −5 docs/ref/contrib/auth.txt
  9. +0 −6 docs/ref/contrib/csrf.txt
  10. +3 −11 docs/ref/contrib/flatpages.txt
  11. +1 −3 docs/ref/contrib/humanize.txt
  12. +4 −12 docs/ref/contrib/sitemaps.txt
  13. +0 −14 docs/ref/contrib/staticfiles.txt
  14. +0 −14 docs/ref/databases.txt
  15. +6 −28 docs/ref/django-admin.txt
  16. +0 −2 docs/ref/forms/fields.txt
  17. +0 −2 docs/ref/forms/widgets.txt
  18. +0 −3 docs/ref/middleware.txt
  19. +0 −2 docs/ref/models/fields.txt
  20. +0 −4 docs/ref/models/options.txt
  21. +6 −16 docs/ref/models/querysets.txt
  22. +0 −9 docs/ref/request-response.txt
  23. +0 −31 docs/ref/settings.txt
  24. +0 −2 docs/ref/signals.txt
  25. +6 −7 docs/ref/templates/api.txt
  26. +0 −19 docs/ref/templates/builtins.txt
  27. +0 −2 docs/ref/urlresolvers.txt
  28. +0 −3 docs/ref/urls.txt
  29. +0 −8 docs/ref/utils.txt
  30. +0 −2 docs/ref/validators.txt
  31. +8 −15 docs/topics/auth/default.txt
  32. +2 −11 docs/topics/auth/passwords.txt
  33. +0 −2 docs/topics/cache.txt
  34. +7 −8 docs/topics/db/queries.txt
  35. +0 −3 docs/topics/db/tablespaces.txt
  36. +0 −3 docs/topics/db/transactions.txt
  37. +0 −2 docs/topics/forms/formsets.txt
  38. +0 −2 docs/topics/forms/modelforms.txt
  39. +0 −2 docs/topics/http/decorators.txt
  40. +0 −5 docs/topics/http/sessions.txt
  41. +3 −7 docs/topics/http/urls.txt
  42. +0 −2 docs/topics/http/views.txt
  43. +0 −2 docs/topics/i18n/timezones.txt
  44. +0 −11 docs/topics/i18n/translation.txt
  45. +0 −4 docs/topics/logging.txt
  46. +0 −7 docs/topics/pagination.txt
  47. +0 −2 docs/topics/signing.txt
  48. +0 −4 docs/topics/testing/advanced.txt
  49. +0 −28 docs/topics/testing/overview.txt
@@ -333,8 +333,6 @@ Template filter code falls into one of two situations:
Filters and time zones Filters and time zones
~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~
.. versionadded:: 1.4
If you write a custom filter that operates on :class:`~datetime.datetime` If you write a custom filter that operates on :class:`~datetime.datetime`
objects, you'll usually register it with the ``expects_localtime`` flag set to objects, you'll usually register it with the ``expects_localtime`` flag set to
``True``: ``True``:
@@ -764,8 +762,6 @@ Or, using decorator syntax:
For more information on how the ``takes_context`` option works, see the section For more information on how the ``takes_context`` option works, see the section
on :ref:`inclusion tags<howto-custom-template-tags-inclusion-tags>`. on :ref:`inclusion tags<howto-custom-template-tags-inclusion-tags>`.
.. versionadded:: 1.4
If you need to rename your tag, you can provide a custom name for it: If you need to rename your tag, you can provide a custom name for it:
.. code-block:: python .. code-block:: python
@@ -776,8 +772,6 @@ If you need to rename your tag, you can provide a custom name for it:
def some_function(value): def some_function(value):
return value - 2 return value - 2
.. versionadded:: 1.4
``simple_tag`` functions may accept any number of positional or keyword ``simple_tag`` functions may accept any number of positional or keyword
arguments. For example: arguments. For example:
@@ -865,16 +859,14 @@ template loader, we'd register the tag like this:
# Here, register is a django.template.Library instance, as before # Here, register is a django.template.Library instance, as before
register.inclusion_tag('results.html')(show_results) register.inclusion_tag('results.html')(show_results)
.. versionchanged:: 1.4 Alternatively it is possible to register the inclusion tag using a
:class:`django.template.Template` instance:
Alternatively it is possible to register the inclusion tag using a
:class:`django.template.Template` instance:
.. code-block:: python .. code-block:: python
from django.template.loader import get_template from django.template.loader import get_template
t = get_template('results.html') t = get_template('results.html')
register.inclusion_tag(t)(show_results) register.inclusion_tag(t)(show_results)
As always, decorator syntax works as well, so we could have written: As always, decorator syntax works as well, so we could have written:
@@ -932,8 +924,6 @@ The ``takes_context`` parameter defaults to ``False``. When it's set to
``True``, the tag is passed the context object, as in this example. That's the ``True``, the tag is passed the context object, as in this example. That's the
only difference between this case and the previous ``inclusion_tag`` example. only difference between this case and the previous ``inclusion_tag`` example.
.. versionadded:: 1.4
``inclusion_tag`` functions may accept any number of positional or keyword ``inclusion_tag`` functions may accept any number of positional or keyword
arguments. For example: arguments. For example:
@@ -1046,8 +1036,6 @@ context-updating template tag, you might want to consider using an
Assignment tags Assignment tags
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
.. versionadded:: 1.4
To ease the creation of tags setting a variable in the context, Django provides To ease the creation of tags setting a variable in the context, Django provides
a helper function, ``assignment_tag``. This function works the same way as a helper function, ``assignment_tag``. This function works the same way as
:ref:`simple_tag<howto-custom-template-tags-simple-tags>`, except that it :ref:`simple_tag<howto-custom-template-tags-simple-tags>`, except that it
@@ -28,8 +28,6 @@ callable object which the webserver uses to communicate with your code. This is
commonly specified as an object named ``application`` in a Python module commonly specified as an object named ``application`` in a Python module
accessible to the server. accessible to the server.
.. versionchanged:: 1.4
The :djadmin:`startproject` command creates a :file:`projectname/wsgi.py` that The :djadmin:`startproject` command creates a :file:`projectname/wsgi.py` that
contains such an application callable. contains such an application callable.
@@ -106,8 +106,6 @@ The best way to disable this behavior is to set
Filtering error reports Filtering error reports
----------------------- -----------------------
.. versionadded:: 1.4
Filtering sensitive information Filtering sensitive information
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -185,15 +183,11 @@ production environment (that is, where :setting:`DEBUG` is set to ``False``):
def my_view(request): def my_view(request):
... ...
.. note:: All POST parameters are systematically filtered out of error reports for
certain :mod:`django.contrib.auth.views` views (``login``,
.. versionchanged:: 1.4 ``password_reset_confirm``, ``password_change``, and ``add_view`` and
``user_change_password`` in the ``auth`` admin) to prevent the leaking of
Since version 1.4, all POST parameters are systematically filtered out of sensitive information such as user passwords.
error reports for certain :mod:`django.contrib.auth.views` views (
``login``, ``password_reset_confirm``, ``password_change``, and
``add_view`` and ``user_change_password`` in the ``auth`` admin) to prevent
the leaking of sensitive information such as user passwords.
.. _custom-error-reports: .. _custom-error-reports:
@@ -40,11 +40,6 @@ FormMixin
Retrieve initial data for the form. By default, returns a copy of Retrieve initial data for the form. By default, returns a copy of
:attr:`~django.views.generic.edit.FormMixin.initial`. :attr:`~django.views.generic.edit.FormMixin.initial`.
.. versionchanged:: 1.4
In Django 1.3, this method was returning the
:attr:`~django.views.generic.edit.FormMixin.initial` class variable
itself.
.. method:: get_form_class() .. method:: get_form_class()
Retrieve the form class to instantiate. By default Retrieve the form class to instantiate. By default
@@ -31,15 +31,11 @@ SingleObjectMixin
.. attribute:: slug_url_kwarg .. attribute:: slug_url_kwarg
.. versionadded:: 1.4
The name of the URLConf keyword argument that contains the slug. By The name of the URLConf keyword argument that contains the slug. By
default, ``slug_url_kwarg`` is ``'slug'``. default, ``slug_url_kwarg`` is ``'slug'``.
.. attribute:: pk_url_kwarg .. attribute:: pk_url_kwarg
.. versionadded:: 1.4
The name of the URLConf keyword argument that contains the primary key. The name of the URLConf keyword argument that contains the primary key.
By default, ``pk_url_kwarg`` is ``'pk'``. By default, ``pk_url_kwarg`` is ``'pk'``.
@@ -10,9 +10,6 @@ against `clickjacking`_. This type of attack occurs when a malicious site
tricks a user into clicking on a concealed element of another site which they tricks a user into clicking on a concealed element of another site which they
have loaded in a hidden frame or iframe. have loaded in a hidden frame or iframe.
.. versionadded:: 1.4
The clickjacking middleware and decorators were added.
.. _clickjacking: http://en.wikipedia.org/wiki/Clickjacking .. _clickjacking: http://en.wikipedia.org/wiki/Clickjacking
An example of clickjacking An example of clickjacking
@@ -180,8 +180,6 @@ subclass::
values defined in :attr:`ModelAdmin.readonly_fields` to be displayed as values defined in :attr:`ModelAdmin.readonly_fields` to be displayed as
read-only. read-only.
.. versionadded:: 1.4
To display multiple fields on the same line, wrap those fields in their own To display multiple fields on the same line, wrap those fields in their own
tuple. In this example, the ``url`` and ``title`` fields will display on the tuple. In this example, the ``url`` and ``title`` fields will display on the
same line and the ``content`` field will be displayed below them in its same line and the ``content`` field will be displayed below them in its
@@ -586,8 +584,6 @@ subclass::
class PersonAdmin(UserAdmin): class PersonAdmin(UserAdmin):
list_filter = ('company__name',) list_filter = ('company__name',)
.. versionadded:: 1.4
* a class inheriting from :mod:`django.contrib.admin.SimpleListFilter`, * a class inheriting from :mod:`django.contrib.admin.SimpleListFilter`,
which you need to provide the ``title`` and ``parameter_name`` which you need to provide the ``title`` and ``parameter_name``
attributes to and override the ``lookups`` and ``queryset`` methods, attributes to and override the ``lookups`` and ``queryset`` methods,
@@ -673,8 +669,6 @@ subclass::
birthday__lte=date(1999, 12, 31)).exists(): birthday__lte=date(1999, 12, 31)).exists():
yield ('90s', _('in the nineties')) yield ('90s', _('in the nineties'))
.. versionadded:: 1.4
* a tuple, where the first element is a field name and the second * a tuple, where the first element is a field name and the second
element is a class inheriting from element is a class inheriting from
:mod:`django.contrib.admin.FieldListFilter`, for example:: :mod:`django.contrib.admin.FieldListFilter`, for example::
@@ -691,8 +685,6 @@ subclass::
The ``FieldListFilter`` API is considered internal and might be The ``FieldListFilter`` API is considered internal and might be
changed. changed.
.. versionadded:: 1.4
It is possible to specify a custom template for rendering a list filter:: It is possible to specify a custom template for rendering a list filter::
class FilterWithCustomTemplate(SimpleListFilter): class FilterWithCustomTemplate(SimpleListFilter):
@@ -703,8 +695,6 @@ subclass::
.. attribute:: ModelAdmin.list_max_show_all .. attribute:: ModelAdmin.list_max_show_all
.. versionadded:: 1.4
Set ``list_max_show_all`` to control how many items can appear on a "Show Set ``list_max_show_all`` to control how many items can appear on a "Show
all" admin change list page. The admin will display a "Show all" link on the all" admin change list page. The admin will display a "Show all" link on the
change list only if the total result count is less than or equal to this change list only if the total result count is less than or equal to this
@@ -738,15 +728,9 @@ subclass::
If this isn't provided, the Django admin will use the model's default If this isn't provided, the Django admin will use the model's default
ordering. ordering.
.. versionadded:: 1.4
If you need to specify a dynamic order (for example depending on user or If you need to specify a dynamic order (for example depending on user or
language) you can implement a :meth:`~ModelAdmin.get_ordering` method. language) you can implement a :meth:`~ModelAdmin.get_ordering` method.
.. versionchanged:: 1.4
Django honors all elements in the list/tuple; before 1.4, only the first
was respected.
.. attribute:: ModelAdmin.paginator .. attribute:: ModelAdmin.paginator
@@ -1017,8 +1001,6 @@ templates used by the :class:`ModelAdmin` views:
.. method:: ModelAdmin.get_ordering(self, request) .. method:: ModelAdmin.get_ordering(self, request)
.. versionadded:: 1.4
The ``get_ordering`` method takes a``request`` as parameter and The ``get_ordering`` method takes a``request`` as parameter and
is expected to return a ``list`` or ``tuple`` for ordering similar is expected to return a ``list`` or ``tuple`` for ordering similar
to the :attr:`ordering` attribute. For example:: to the :attr:`ordering` attribute. For example::
@@ -1033,8 +1015,6 @@ templates used by the :class:`ModelAdmin` views:
.. method:: ModelAdmin.save_related(self, request, form, formsets, change) .. method:: ModelAdmin.save_related(self, request, form, formsets, change)
.. versionadded:: 1.4
The ``save_related`` method is given the ``HttpRequest``, the parent The ``save_related`` method is given the ``HttpRequest``, the parent
``ModelForm`` instance, the list of inline formsets and a boolean value ``ModelForm`` instance, the list of inline formsets and a boolean value
based on whether the parent is being added or changed. Here you can do any based on whether the parent is being added or changed. Here you can do any
@@ -1050,26 +1030,20 @@ templates used by the :class:`ModelAdmin` views:
.. method:: ModelAdmin.get_prepopulated_fields(self, request, obj=None) .. method:: ModelAdmin.get_prepopulated_fields(self, request, obj=None)
.. versionadded:: 1.4
The ``get_prepopulated_fields`` method is given the ``HttpRequest`` and the The ``get_prepopulated_fields`` method is given the ``HttpRequest`` and the
``obj`` being edited (or ``None`` on an add form) and is expected to return ``obj`` being edited (or ``None`` on an add form) and is expected to return
a ``dictionary``, as described above in the :attr:`ModelAdmin.prepopulated_fields` a ``dictionary``, as described above in the :attr:`ModelAdmin.prepopulated_fields`
section. section.
.. method:: ModelAdmin.get_list_display(self, request) .. method:: ModelAdmin.get_list_display(self, request)
.. versionadded:: 1.4
The ``get_list_display`` method is given the ``HttpRequest`` and is The ``get_list_display`` method is given the ``HttpRequest`` and is
expected to return a ``list`` or ``tuple`` of field names that will be expected to return a ``list`` or ``tuple`` of field names that will be
displayed on the changelist view as described above in the displayed on the changelist view as described above in the
:attr:`ModelAdmin.list_display` section. :attr:`ModelAdmin.list_display` section.
.. method:: ModelAdmin.get_list_display_links(self, request, list_display) .. method:: ModelAdmin.get_list_display_links(self, request, list_display)
.. versionadded:: 1.4
The ``get_list_display_links`` method is given the ``HttpRequest`` and The ``get_list_display_links`` method is given the ``HttpRequest`` and
the ``list`` or ``tuple`` returned by :meth:`ModelAdmin.get_list_display`. the ``list`` or ``tuple`` returned by :meth:`ModelAdmin.get_list_display`.
It is expected to return a ``list`` or ``tuple`` of field names on the It is expected to return a ``list`` or ``tuple`` of field names on the
@@ -1341,10 +1315,6 @@ Other methods
Django view for the model instance edition page. See note below. Django view for the model instance edition page. See note below.
.. versionchanged:: 1.4
The ``form_url`` parameter was added.
.. method:: ModelAdmin.changelist_view(self, request, extra_context=None) .. method:: ModelAdmin.changelist_view(self, request, extra_context=None)
Django view for the model instances change list/actions page. See note Django view for the model instances change list/actions page. See note
@@ -1386,12 +1356,10 @@ provided some extra mapping data that would not otherwise be available::
return super(MyModelAdmin, self).change_view(request, object_id, return super(MyModelAdmin, self).change_view(request, object_id,
form_url, extra_context=extra_context) form_url, extra_context=extra_context)
.. versionadded:: 1.4 These views return :class:`~django.template.response.TemplateResponse`
These views now return :class:`~django.template.response.TemplateResponse`
instances which allow you to easily customize the response data before instances which allow you to easily customize the response data before
rendering. For more details, see the rendering. For more details, see the :doc:`TemplateResponse documentation
:doc:`TemplateResponse documentation </ref/template-response>`. </ref/template-response>`.
.. _modeladmin-media-definitions: .. _modeladmin-media-definitions:
@@ -1514,9 +1482,6 @@ adds some of its own (the shared features are actually defined in the
- :attr:`~InlineModelAdmin.raw_id_fields` - :attr:`~InlineModelAdmin.raw_id_fields`
- :meth:`~ModelAdmin.formfield_for_foreignkey` - :meth:`~ModelAdmin.formfield_for_foreignkey`
- :meth:`~ModelAdmin.formfield_for_manytomany` - :meth:`~ModelAdmin.formfield_for_manytomany`
.. versionadded:: 1.4
- :meth:`~ModelAdmin.has_add_permission` - :meth:`~ModelAdmin.has_add_permission`
- :meth:`~ModelAdmin.has_change_permission` - :meth:`~ModelAdmin.has_change_permission`
- :meth:`~ModelAdmin.has_delete_permission` - :meth:`~ModelAdmin.has_delete_permission`
@@ -2043,8 +2008,6 @@ your URLconf. Specifically, add these four patterns:
the URLs starting with ``^admin/`` before the line that includes the admin app the URLs starting with ``^admin/`` before the line that includes the admin app
itself). itself).
.. versionchanged:: 1.4
The presence of the ``admin_password_reset`` named URL will cause a "forgotten The presence of the ``admin_password_reset`` named URL will cause a "forgotten
your password?" link to appear on the default admin log-in page under the your password?" link to appear on the default admin log-in page under the
password box. password box.
@@ -2108,8 +2071,6 @@ if you specifically wanted the admin view from the admin instance named
For more details, see the documentation on :ref:`reversing namespaced URLs For more details, see the documentation on :ref:`reversing namespaced URLs
<topics-http-reversing-url-namespaces>`. <topics-http-reversing-url-namespaces>`.
.. versionadded:: 1.4
To allow easier reversing of the admin urls in templates, Django provides an To allow easier reversing of the admin urls in templates, Django provides an
``admin_urlname`` filter which takes an action as argument: ``admin_urlname`` filter which takes an action as argument:
@@ -222,11 +222,6 @@ Manager methods
.. method:: create_user(username, email=None, password=None) .. method:: create_user(username, email=None, password=None)
.. versionchanged:: 1.4
The ``email`` parameter was made optional. The username
parameter is now checked for emptiness and raises a
:exc:`~exceptions.ValueError` in case of a negative result.
Creates, saves and returns a :class:`~django.contrib.auth.models.User`. Creates, saves and returns a :class:`~django.contrib.auth.models.User`.
The :attr:`~django.contrib.auth.models.User.username` and The :attr:`~django.contrib.auth.models.User.username` and
@@ -410,8 +410,6 @@ Utilities
.. function:: ensure_csrf_cookie(view) .. function:: ensure_csrf_cookie(view)
.. versionadded:: 1.4
This decorator forces a view to send the CSRF cookie. This decorator forces a view to send the CSRF cookie.
Scenarios Scenarios
@@ -517,8 +515,6 @@ whatever you want.
CSRF_COOKIE_PATH CSRF_COOKIE_PATH
---------------- ----------------
.. versionadded:: 1.4
Default: ``'/'`` Default: ``'/'``
The path set on the CSRF cookie. This should either match the URL path of your The path set on the CSRF cookie. This should either match the URL path of your
@@ -531,8 +527,6 @@ its own CSRF cookie.
CSRF_COOKIE_SECURE CSRF_COOKIE_SECURE
------------------ ------------------
.. versionadded:: 1.4
Default: ``False`` Default: ``False``
Whether to use a secure cookie for the CSRF cookie. If this is set to ``True``, Whether to use a secure cookie for the CSRF cookie. If this is set to ``True``,
@@ -117,17 +117,9 @@ can do all of the work.
:class:`~django.template.RequestContext` in rendering the :class:`~django.template.RequestContext` in rendering the
template. template.
.. versionchanged:: 1.4 The middleware will only add a trailing slash and redirect (by looking
The middleware will only add a trailing slash and redirect (by looking at the :setting:`APPEND_SLASH` setting) if the resulting URL refers to
at the :setting:`APPEND_SLASH` setting) if the resulting URL refers to a valid flatpage. Redirects are permanent (301 status code).
a valid flatpage. Previously requesting a non-existent flatpage
would redirect to the same URL with an apppended slash first and
subsequently raise a 404.
.. versionchanged:: 1.4
Redirects by the middleware are permanent (301 status code) instead of
temporary (302) to match behavior of the
:class:`~django.middleware.common.CommonMiddleware`.
If it doesn't find a match, the request continues to be processed as usual. If it doesn't find a match, the request continues to be processed as usual.
@@ -100,10 +100,8 @@ Examples (when 'today' is 17 Feb 2007):
naturaltime naturaltime
----------- -----------
.. versionadded:: 1.4
For datetime values, returns a string representing how many seconds, For datetime values, returns a string representing how many seconds,
minutes or hours ago it was -- falling back to the :tfilter:`timesince` minutes or hours ago it was -- falling back to the :tfilter:`timesince`
format if the value is more than a day old. In case the datetime value is in format if the value is more than a day old. In case the datetime value is in
the future the return value will automatically use an appropriate phrase. the future the return value will automatically use an appropriate phrase.
Oops, something went wrong.

0 comments on commit 7ee7599

Please sign in to comment.