Removed versionadded/changed annotations for 2.0.

This commit is contained in:
Tim Graham 2018-05-17 10:16:32 -04:00
parent 1cbd3d7874
commit 7543ab1f8d
35 changed files with 0 additions and 234 deletions

View File

@ -11,8 +11,6 @@ Simple mixins
.. attribute:: extra_context
.. versionadded:: 2.0
A dictionary to include in the context. This is a convenient way of
specifying some simple context in
:meth:`~django.views.generic.base.View.as_view`. Example usage::

View File

@ -1102,8 +1102,6 @@ subclass::
.. attribute:: ModelAdmin.autocomplete_fields
.. versionadded:: 2.0
``autocomplete_fields`` is a list of ``ForeignKey`` and/or
``ManyToManyField`` fields you would like to change to `Select2
<https://select2.org/>`_ autocomplete inputs.
@ -1525,8 +1523,6 @@ templates used by the :class:`ModelAdmin` views:
.. method:: ModelAdmin.get_autocomplete_fields(request)
.. versionadded:: 2.0
The ``get_autocomplete_fields()`` method is given the ``HttpRequest`` and is
expected to return a ``list`` or ``tuple`` of field names that will be
displayed with an autocomplete widget as described above in the

View File

@ -51,10 +51,6 @@ Fields
Optional (:attr:`blank=True <django.db.models.Field.blank>`). 150
characters or fewer.
.. versionchanged:: 2.0
The ``max_length`` increased from 30 to 150 characters.
.. attribute:: email
Optional (:attr:`blank=True <django.db.models.Field.blank>`). Email

View File

@ -179,8 +179,6 @@ Widget classes
.. attribute:: default_zoom
.. versionadded:: 2.0
The default map zoom is ``12``.
The :class:`OpenLayersWidget` note about JavaScript file hosting above also

View File

@ -82,10 +82,6 @@ Keyword Argument Description
representation -- the default value is 8.
===================== =====================================================
.. versionchanged:: 2.0
MySQL support was added.
``AsGML``
=========
@ -172,8 +168,6 @@ __ https://www.w3.org/Graphics/SVG/
.. class:: Azimuth(point_a, point_b, **extra)
.. versionadded:: 2.0
*Availability*: `PostGIS <https://postgis.net/docs/ST_Azimuth.html>`__,
SpatiaLite (LWGEOM)
@ -323,10 +317,6 @@ representation of the geometry.
The ``precision`` keyword argument controls the number of characters in the
result.
.. versionchanged:: 2.0
MySQL support was added.
__ https://en.wikipedia.org/wiki/Geohash
``Intersection``
@ -353,10 +343,6 @@ intersection between them.
Accepts a geographic field or expression and tests if the value is well formed.
Returns ``True`` if its value is a valid geometry and ``False`` otherwise.
.. versionchanged:: 2.0
MySQL support was added.
``Length``
==========
@ -382,8 +368,6 @@ MySQL doesn't support length calculations on geographic SRSes.
.. class:: LineLocatePoint(linestring, point, **extra)
.. versionadded:: 2.0
*Availability*: `PostGIS <https://postgis.net/docs/ST_LineLocatePoint.html>`__,
SpatiaLite

View File

@ -1160,12 +1160,6 @@ blue.
>>> rst.name # Stored in a random path in the vsimem filesystem.
'/vsimem/da300bdb-129d-49a8-b336-e410a9428dad'
.. versionchanged:: 2.0
Added the ability to read and write rasters in GDAL's memory-based
virtual filesystem. ``GDALRaster`` objects can now be converted to and
from binary data in-memory.
.. attribute:: name
The name of the source which is equivalent to the input file path or the name
@ -1406,8 +1400,6 @@ blue.
.. attribute:: info
.. versionadded:: 2.0
Returns a string with a summary of the raster. This is equivalent to
the `gdalinfo`__ command line utility.
@ -1415,8 +1407,6 @@ blue.
.. attribute:: metadata
.. versionadded:: 2.0
The metadata of this raster, represented as a nested dictionary. The
first-level key is the metadata domain. The second-level contains the
metadata item names and values from each domain.
@ -1440,15 +1430,11 @@ blue.
.. attribute:: vsi_buffer
.. versionadded:: 2.0
A ``bytes`` representation of this raster. Returns ``None`` for rasters
that are not stored in GDAL's virtual filesystem.
.. attribute:: is_vsi_based
.. versionadded:: 2.0
A boolean indicating if this raster is stored in GDAL's virtual
filesystem.
@ -1542,8 +1528,6 @@ blue.
.. method:: color_interp(as_string=False)
.. versionadded:: 2.0
The color interpretation for the band, as an integer between 0and 16.
If ``as_string`` is ``True``, the data type is returned as a string
with the following possible values:
@ -1618,8 +1602,6 @@ blue.
.. attribute:: metadata
.. versionadded:: 2.0
The metadata of this band. The functionality is identical to
:attr:`GDALRaster.metadata`.
@ -1721,8 +1703,6 @@ Key Default Usage
.. object:: papsz_options
.. versionadded:: 2.0
A dictionary with raster creation options. The key-value pairs of the
input dictionary are passed to the driver on creation of the raster.

View File

@ -322,10 +322,6 @@ MySQL, PostGIS, SpatiaLite ``ST_IsValid(poly)``
Oracle ``SDO_GEOM.VALIDATE_GEOMETRY_WITH_CONTEXT(poly, 0.05) = 'TRUE'``
========================== ================================================================
.. versionchanged:: 2.0
MySQL support was added.
.. fieldlookup:: overlaps
``overlaps``
@ -631,10 +627,6 @@ simpler `ST_Distance <https://postgis.net/docs/ST_Distance.html>`__ function is
used with projected coordinate systems. Rasters are converted to geometries for
spheroid based lookups.
.. versionadded:: 2.0
MySQL support was added.
.. fieldlookup:: distance_gt
``distance_gt``

View File

@ -203,13 +203,6 @@ The ``srid`` parameter, if given, is set as the SRID of the created geometry if
...
ValueError: Input geometry already has SRID: 1.
.. versionchanged:: 2.0
In older versions, the ``srid`` parameter is handled differently for WKT
and WKB input. For WKT, ``srid`` is used only if the input geometry doesn't
have an SRID. For WKB, ``srid`` (if given) replaces the SRID of the input
geometry.
The following input formats, along with their corresponding Python types,
are accepted:
@ -225,10 +218,6 @@ GeoJSON_ ``str``
For the GeoJSON format, the SRID is set based on the ``crs`` member. If ``crs``
isn't provided, the SRID defaults to 4326.
.. versionchanged:: 2.0
In older versions, SRID isn't set for geometries initialized from GeoJSON.
.. _GeoJSON: https://tools.ietf.org/html/rfc7946
.. classmethod:: GEOSGeometry.from_gml(gml_string)

View File

@ -28,8 +28,6 @@ General-purpose aggregation functions
.. attribute:: distinct
.. versionadded:: 2.0
An optional boolean argument that determines if array values
will be distinct. Defaults to ``False``.

View File

@ -12,8 +12,6 @@ All of these functions are available from the
.. class:: RandomUUID()
.. versionadded:: 2.0
Returns a version 4 UUID.
The `pgcrypto extension`_ must be installed. You can use the

View File

@ -43,17 +43,11 @@ available from the ``django.contrib.postgres.indexes`` module.
.. _GIN Fast Update Technique: https://www.postgresql.org/docs/current/static/gin-implementation.html#GIN-FAST-UPDATE
.. _gin_pending_list_limit: https://www.postgresql.org/docs/current/static/runtime-config-client.html#GUC-GIN-PENDING-LIST-LIMIT
.. versionchanged:: 2.0
The ``fastupdate`` and ``gin_pending_list_limit`` parameters were added.
``GistIndex``
=============
.. class:: GistIndex(buffering=None, fillfactor=None, **options)
.. versionadded:: 2.0
Creates a `GiST index
<https://www.postgresql.org/docs/current/static/gist.html>`_. These indexes
are automatically created on spatial fields with :attr:`spatial_index=True

View File

@ -61,8 +61,6 @@ run the query ``CREATE EXTENSION IF NOT EXISTS hstore;``.
.. class:: BtreeGistExtension()
.. versionadded:: 2.0
Install the ``btree_gist`` extension.
``CITextExtension``
@ -77,8 +75,6 @@ run the query ``CREATE EXTENSION IF NOT EXISTS hstore;``.
.. class:: CryptoExtension()
.. versionadded:: 2.0
Installs the ``pgcrypto`` extension.
``HStoreExtension``

View File

@ -273,10 +273,6 @@ The sitemap framework provides a convenience class for a common case:
and :attr:`~Sitemap.protocol` keyword arguments allow specifying these
attributes for all URLs.
.. versionadded:: 2.0
The ``protocol`` keyword argument was added.
Example
-------

View File

@ -490,12 +490,6 @@ or ``None`` to use the server's configured isolation level. However, Django
works best with and defaults to read committed rather than MySQL's default,
repeatable read. Data loss is possible with repeatable read.
.. versionchanged:: 2.0
In older versions, the MySQL database backend defaults to using the
database's isolation level (which defaults to repeatable read) rather
than read committed.
.. _transaction isolation level: https://dev.mysql.com/doc/refman/en/innodb-transaction-isolation-levels.html
Creating your tables

View File

@ -240,8 +240,6 @@ compare against Django's default settings.
.. django-admin-option:: --output {hash,unified}
.. versionadded:: 2.0
Specifies the output format. Available values are ``hash`` and ``unified``.
``hash`` is the default mode that displays the output that's described above.
``unified`` displays the output similar to ``diff -u``. Default settings are
@ -437,8 +435,6 @@ Specifies a single app to look for fixtures in rather than looking in all apps.
.. django-admin-option:: --format FORMAT
.. versionadded:: 2.0
Specifies the :ref:`serialization format <serialization-formats>` (e.g.,
``json`` or ``xml``) for fixtures :ref:`read from stdin
<loading-fixtures-stdin>`.
@ -582,8 +578,6 @@ specify you want to load data into the ``master`` database.
Loading fixtures from ``stdin``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. versionadded:: 2.0
You can use a dash as the fixture name to load input from ``sys.stdin``. For
example::
@ -695,8 +689,6 @@ understand each message's context.
.. django-admin-option:: --add-location [{full,file,never}]
.. versionadded:: 2.0
Controls ``#: filename:line`` comment lines in language files. If the option
is:
@ -1130,8 +1122,6 @@ Suppresses all user prompts.
.. django-admin-option:: --squashed-name SQUASHED_NAME
.. versionadded:: 2.0
Sets the name of the squashed migration. When omitted, the name is based on the
first and last migration, with ``_squashed_`` in between.

View File

@ -58,10 +58,6 @@ The ``File`` class
It can be used as a context manager, e.g. ``with file.open() as f:``.
.. versionchanged:: 2.0
Context manager support was added.
.. method:: __iter__()
Iterate over the file yielding one line at a time.

View File

@ -167,8 +167,6 @@ directly in HTML.
.. method:: Form.errors.get_json_data(escape_html=False)
.. versionadded:: 2.0
Returns the errors as a dictionary suitable for serializing to JSON.
:meth:`Form.errors.as_json()` returns serialized JSON, while this returns the
error data before it's serialized.

View File

@ -878,8 +878,6 @@ Composite widgets
.. attribute:: SplitDateTimeWidget.date_attrs
.. attribute:: SplitDateTimeWidget.time_attrs
.. versionadded:: 2.0
Similar to :attr:`Widget.attrs`. A dictionary containing HTML
attributes to be set on the rendered :class:`DateInput` and
:class:`TimeInput` widgets, respectively. If these attributes aren't

View File

@ -178,10 +178,6 @@ Django usually uses the databases' extract function, so you may use any
``lookup_name`` that your database supports. A ``tzinfo`` subclass, usually
provided by ``pytz``, can be passed to extract a value in a specific timezone.
.. versionchanged:: 2.0
Support for ``DurationField`` was added.
Given the datetime ``2015-06-15 23:30:01.000321+00:00``, the built-in
``lookup_name``\s return:
@ -274,8 +270,6 @@ Usage example::
.. class:: ExtractQuarter(expression, tzinfo=None, **extra)
.. versionadded:: 2.0
.. attribute:: lookup_name = 'quarter'
These are logically equivalent to ``Extract('date_field', lookup_name)``. Each
@ -517,8 +511,6 @@ Usage example::
.. class:: TruncQuarter(expression, output_field=None, tzinfo=None, **extra)
.. versionadded:: 2.0
.. attribute:: kind = 'quarter'
These are logically equivalent to ``Trunc('date_field', kind)``. They truncate
@ -938,8 +930,6 @@ spaces.
.. class:: StrIndex(string, substring, **extra)
.. versionadded:: 2.0
Returns a positive integer corresponding to the 1-indexed position of the first
occurrence of ``substring`` inside ``string``, or 0 if ``substring`` is not
found.
@ -1028,8 +1018,6 @@ Usage example::
Window functions
================
.. versionadded:: 2.0
There are a number of functions to use in a
:class:`~django.db.models.expressions.Window` expression for computing the rank
of elements or the :class:`Ntile` of some rows.

View File

@ -388,8 +388,6 @@ The ``Aggregate`` API is as follows:
.. attribute:: window_compatible
.. versionadded:: 2.0
Defaults to ``True`` since most aggregate functions can be used as the
source expression in :class:`~django.db.models.expressions.Window`.
@ -417,10 +415,6 @@ and :ref:`filtering-on-annotations` for example usage.
The ``**extra`` kwargs are ``key=value`` pairs that can be interpolated
into the ``template`` attribute.
.. versionchanged:: 2.0
The ``filter`` argument was added.
Creating your own Aggregate Functions
-------------------------------------
@ -694,8 +688,6 @@ should avoid them if possible.
Window functions
----------------
.. versionadded:: 2.0
Window functions provide a way to apply functions on partitions. Unlike a
normal aggregation function which computes a final result for each set defined
by the group by, window functions operate on :ref:`frames <window-frames>` and
@ -902,8 +894,6 @@ calling the appropriate methods on the wrapped expression.
.. attribute:: contains_over_clause
.. versionadded:: 2.0
Tells Django that this expression contains a
:class:`~django.db.models.expressions.Window` expression. It's used,
for example, to disallow window function expressions in queries that
@ -911,15 +901,11 @@ calling the appropriate methods on the wrapped expression.
.. attribute:: filterable
.. versionadded:: 2.0
Tells Django that this expression can be referenced in
:meth:`.QuerySet.filter`. Defaults to ``True``.
.. attribute:: window_compatible
.. versionadded:: 2.0
Tells Django that this expression can be used as the source expression
in :class:`~django.db.models.expressions.Window`. Defaults to
``False``.

View File

@ -58,8 +58,6 @@ than 30 characters and shouldn't start with a number (0-9) or underscore (_).
.. attribute:: Index.db_tablespace
.. versionadded:: 2.0
The name of the :doc:`database tablespace </topics/db/tablespaces>` to use for
this index. For single field indexes, if ``db_tablespace`` isn't provided, the
index is created in the ``db_tablespace`` of the field.

View File

@ -147,10 +147,6 @@ Django quotes column and table names behind the scenes.
See the :meth:`~django.db.models.query.QuerySet.latest` docs for more.
.. versionchanged:: 2.0
Support for a list of fields was added.
``managed``
-----------
@ -291,10 +287,6 @@ Django quotes column and table names behind the scenes.
Default ordering also affects :ref:`aggregation queries
<aggregation-ordering-interaction>`.
.. versionchanged:: 2.0
Support for query expressions was added.
.. warning::
Ordering is not a free operation. Each field you add to the ordering

View File

@ -712,10 +712,6 @@ not having any author::
>>> Entry.objects.values_list('authors')
<QuerySet [('Noam Chomsky',), ('George Orwell',), (None,)]>
.. versionchanged:: 2.0
The ``named`` parameter was added.
``dates()``
~~~~~~~~~~~
@ -1737,10 +1733,6 @@ raised if ``select_for_update()`` is used in autocommit mode.
PostgreSQL doesn't support ``select_for_update()`` with
:class:`~django.db.models.expressions.Window` expressions.
.. versionchanged:: 2.0
The ``of`` argument was added.
``raw()``
~~~~~~~~~
@ -2099,10 +2091,6 @@ Example::
If you pass ``in_bulk()`` an empty list, you'll get an empty dictionary.
.. versionchanged:: 2.0
The ``field_name`` parameter was added.
``iterator()``
~~~~~~~~~~~~~~
@ -2167,10 +2155,6 @@ psycopg mailing list <https://www.postgresql.org/message-id/4D2F2C71.8080805%40d
between the number of rows transferred and the data discarded if the loop
is exited early.
.. versionchanged:: 2.0
The ``chunk_size`` parameter was added.
``latest()``
~~~~~~~~~~~~
@ -2205,10 +2189,6 @@ given parameters.
Note that ``earliest()`` and ``latest()`` exist purely for convenience and
readability.
.. versionchanged:: 2.0
Support for several arguments was added.
.. admonition:: ``earliest()`` and ``latest()`` may return instances with null dates.
Since ordering is delegated to the database, results on fields that allow
@ -2988,8 +2968,6 @@ in the database <database-time-zone-definitions>`.
``quarter``
~~~~~~~~~~~
.. versionadded:: 2.0
For date and datetime fields, a 'quarter of the year' match. Allows chaining
additional field lookups. Takes an integer value between 1 and 4 representing
the quarter of the year.
@ -3216,8 +3194,6 @@ of the return value
``filter``
~~~~~~~~~~
.. versionadded:: 2.0
An optional :class:`Q object <django.db.models.Q>` that's used to filter the
rows that are aggregated.
@ -3428,8 +3404,6 @@ lookups or :class:`Prefetch` objects you want to prefetch for. For example::
``FilteredRelation()`` objects
------------------------------
.. versionadded:: 2.0
.. class:: FilteredRelation(relation_name, *, condition=Q())
.. attribute:: FilteredRelation.relation_name

View File

@ -911,8 +911,6 @@ The maximum size that the DATAFILE_TMP is allowed to grow to.
``DATAFILE_SIZE``
^^^^^^^^^^^^^^^^^
.. versionadded:: 2.0
Default: ``'50M'``
This is an Oracle-specific setting.
@ -924,8 +922,6 @@ The initial size of the DATAFILE.
``DATAFILE_TMP_SIZE``
^^^^^^^^^^^^^^^^^^^^^
.. versionadded:: 2.0
Default: ``'50M'``
This is an Oracle-specific setting.
@ -937,8 +933,6 @@ The initial size of the DATAFILE_TMP.
``DATAFILE_EXTSIZE``
^^^^^^^^^^^^^^^^^^^^
.. versionadded:: 2.0
Default: ``'25M'``
This is an Oracle-specific setting.
@ -950,8 +944,6 @@ The amount by which the DATAFILE is extended when more space is required.
``DATAFILE_TMP_EXTSIZE``
^^^^^^^^^^^^^^^^^^^^^^^^
.. versionadded:: 2.0
Default: ``'25M'``
This is an Oracle-specific setting.

View File

@ -149,12 +149,6 @@ what's passed by :class:`~django.template.backends.django.DjangoTemplates`.
It's required for preserving APIs that rely on a globally available,
implicitly configured engine. Any other use is strongly discouraged.
.. versionchanged:: 2.0
In older versions, raises
:exc:`~django.core.exceptions.ImproperlyConfigured` if multiple
engines are configured rather than returning the first engine.
.. method:: Engine.from_string(template_code)
Compiles the given template code and returns a :class:`Template` object.

View File

@ -12,8 +12,6 @@
.. function:: path(route, view, kwargs=None, name=None)
.. versionadded:: 2.0
Returns an element for inclusion in ``urlpatterns``. For example::
from django.urls import include, path
@ -53,8 +51,6 @@ argument is useful.
.. function:: re_path(route, view, kwargs=None, name=None)
.. versionadded:: 2.0
Returns an element for inclusion in ``urlpatterns``. For example::
from django.urls import include, re_path
@ -108,18 +104,11 @@ The ``view``, ``kwargs`` and ``name`` arguments are the same as for
See :ref:`including-other-urlconfs` and :ref:`namespaces-and-include`.
.. versionchanged:: 2.0
In older versions, this function is located in ``django.conf.urls``. The
old location still works for backwards compatibility.
``register_converter()``
========================
.. function:: register_converter(converter, type_name)
.. versionadded:: 2.0
The function for registering a converter for use in :func:`~django.urls.path()`
``route``\s.

View File

@ -136,10 +136,6 @@ The functions defined in this module share the following properties:
8601 (e.g. ``P4DT1H15M20S`` which is equivalent to ``4 1:15:20``) or
PostgreSQL's day-time interval format (e.g. ``3 days 04:05:06``).
.. versionchanged:: 2.0
Support for PostgreSQL's interval format was added.
``django.utils.decorators``
===========================

View File

@ -306,8 +306,6 @@ to, or in lieu of custom ``field.clean()`` methods.
.. class:: ProhibitNullCharactersValidator(message=None, code=None)
.. versionadded:: 2.0
Raises a :exc:`~django.core.exceptions.ValidationError` if ``str(value)``
contains one or more nulls characters (``'\x00'``).

View File

@ -628,12 +628,6 @@ password resets. You must then provide some key implementation details:
first name. If implemented, this replaces the username in the greeting
to the user in the header of :mod:`django.contrib.admin`.
.. versionchanged:: 2.0
In older versions, subclasses are required to implement
``get_short_name()`` and ``get_full_name()`` as ``AbstractBaseUser``
has implementations that raise ``NotImplementedError``.
.. admonition:: Importing ``AbstractBaseUser``
``AbstractBaseUser`` and ``BaseUserManager`` are importable from

View File

@ -659,10 +659,6 @@ example:
.. sidebar ..
{% endcache %}
.. versionchanged:: 2.0
Older versions don't allow a ``None`` timeout.
Sometimes you might want to cache multiple copies of a fragment depending on
some dynamic data that appears inside the fragment. For example, you might want a
separate cached copy of the sidebar used in the previous example for every user
@ -872,10 +868,6 @@ Like ``cache.set()``, ``set_many()`` takes an optional ``timeout`` parameter.
On supported backends (memcached), ``set_many()`` returns a list of keys that
failed to be inserted.
.. versionchanged:: 2.0
The return value containing list of failing keys was added.
You can delete keys explicitly with ``delete()``. This is an easy way of
clearing the cache for a particular object::

View File

@ -368,10 +368,6 @@ Each ``Author`` in the result set will have the ``num_books`` and
rows. The aggregation ``filter`` argument is only useful when using two or
more aggregations over the same relations with different conditionals.
.. versionchanged:: 2.0
The ``filter`` argument was added to aggregates.
Order of ``annotate()`` and ``filter()`` clauses
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@ -2,8 +2,6 @@
Database instrumentation
========================
.. versionadded:: 2.0
To help you understand and control the queries issued by your code, Django
provides a hook for installing wrapper functions around the execution of
database queries. For example, wrappers can count queries, measure query

View File

@ -372,7 +372,3 @@ Calling stored procedures
with connection.cursor() as cursor:
cursor.callproc('test_procedure', [1, 'test'])
.. versionchanged:: 2.0
The ``kparams`` argument was added.

View File

@ -335,12 +335,6 @@ For example::
Combining ``Media`` objects with assets in a conflicting order results in a
``MediaOrderConflictWarning``.
.. versionchanged:: 2.0
In older versions, the assets of ``Media`` objects are concatenated rather
than merged in a way that tries to preserve the relative ordering of the
elements in each list.
``Media`` on Forms
==================

View File

@ -176,8 +176,6 @@ Methods
.. method:: Paginator.get_page(number)
.. versionadded:: 2.0
Returns a :class:`Page` object with the given 1-based index, while also
handling out of range and invalid page numbers.