summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNick Pope <nick@nickpope.me.uk>2023-11-30 09:51:42 +0000
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2023-12-01 08:38:42 +0100
commitb925fefd7da49e3a1ecbbba82409c655963ab6dd (patch)
tree82921f5810ede1295ce2b67e814f40fa569acfa1 /docs
parent1311f82a6a2d0adf80f9962e06724cd429b1b2c6 (diff)
Deprecated django.contrib.gis.geoip2.GeoIP2.coords().
The `ordering` argument is undocumented and of limited use, so this is effectively the same as `GeoIP2.lon_lat()`.
Diffstat (limited to 'docs')
-rw-r--r--docs/internals/deprecation.txt2
-rw-r--r--docs/ref/contrib/gis/geoip2.txt4
-rw-r--r--docs/releases/5.1.txt3
3 files changed, 9 insertions, 0 deletions
diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt
index edda364b73..0067c8fbf5 100644
--- a/docs/internals/deprecation.txt
+++ b/docs/internals/deprecation.txt
@@ -64,6 +64,8 @@ details on these changes.
* The undocumented ``django.utils.itercompat.is_iterable()`` function and the
``django.utils.itercompat`` module will be removed.
+* The ``django.contrib.gis.geoip2.GeoIP2.coords()`` method will be removed.
+
.. _deprecation-removed-in-5.1:
5.1
diff --git a/docs/ref/contrib/gis/geoip2.txt b/docs/ref/contrib/gis/geoip2.txt
index 5468cff29d..dc735ff13e 100644
--- a/docs/ref/contrib/gis/geoip2.txt
+++ b/docs/ref/contrib/gis/geoip2.txt
@@ -133,6 +133,10 @@ Coordinate Retrieval
Returns a coordinate tuple of (longitude, latitude).
+.. deprecated:: 5.1
+
+ Use :meth:`.GeoIP2.lon_lat` instead.
+
.. method:: GeoIP2.lon_lat(query)
Returns a coordinate tuple of (longitude, latitude).
diff --git a/docs/releases/5.1.txt b/docs/releases/5.1.txt
index 4c95e4677f..33b4f1c491 100644
--- a/docs/releases/5.1.txt
+++ b/docs/releases/5.1.txt
@@ -307,6 +307,9 @@ Miscellaneous
``django.utils.itercompat`` module are deprecated. Use
``isinstance(..., collections.abc.Iterable)`` instead.
+* The ``django.contrib.gis.geoip2.GeoIP2.coords()`` method is deprecated. Use
+ ``django.contrib.gis.geoip2.GeoIP2.lon_lat()`` instead.
+
Features removed in 5.1
=======================