summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDavid Smith <smithdc@gmail.com>2024-01-22 17:55:40 +0000
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2024-01-23 05:37:59 +0100
commitf4c597346453c44769726d2ac061fbc028b2fd5b (patch)
tree643d315a856a875df5977b2ec769b7782db58812 /docs
parent8570e091d025c4aacc6b76597a3322030c2f8162 (diff)
Refs #35058 -- Deprecated OGRGeometry.coord_dim setter.
Reflecting a change in the underlying GDAL library (since GDAL 2.1) using coord_dim to set a geometries dimensions is deprecated in favor of set_3d().
Diffstat (limited to 'docs')
-rw-r--r--docs/internals/deprecation.txt3
-rw-r--r--docs/ref/contrib/gis/gdal.txt8
-rw-r--r--docs/releases/5.1.txt3
3 files changed, 12 insertions, 2 deletions
diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt
index 07e0f46856..e91ac062cb 100644
--- a/docs/internals/deprecation.txt
+++ b/docs/internals/deprecation.txt
@@ -71,6 +71,9 @@ details on these changes.
* Support for passing positional arguments to ``Model.save()`` and
``Model.asave()`` will be removed.
+* The setter for ``django.contrib.gis.gdal.OGRGeometry.coord_dim`` will be
+ removed.
+
.. _deprecation-removed-in-5.1:
5.1
diff --git a/docs/ref/contrib/gis/gdal.txt b/docs/ref/contrib/gis/gdal.txt
index c98c76cd10..4b7a706fc4 100644
--- a/docs/ref/contrib/gis/gdal.txt
+++ b/docs/ref/contrib/gis/gdal.txt
@@ -553,8 +553,12 @@ coordinate transformation:
.. attribute:: coord_dim
- Returns or sets the coordinate dimension of this geometry. For example, the
- value would be 2 for two-dimensional geometries.
+ Returns the coordinate dimension of this geometry. For example, the value
+ would be 2 for two-dimensional geometries.
+
+ .. deprecated:: 5.1
+
+ The ``coord_dim`` setter is deprecated. Use :meth:`.set_3d` instead.
.. attribute:: is_3d
diff --git a/docs/releases/5.1.txt b/docs/releases/5.1.txt
index be609cea7f..0cf249f3cf 100644
--- a/docs/releases/5.1.txt
+++ b/docs/releases/5.1.txt
@@ -378,6 +378,9 @@ Miscellaneous
* Passing positional arguments to :meth:`.Model.save` and :meth:`.Model.asave`
is deprecated in favor of keyword-only arguments.
+* Setting ``django.contrib.gis.gdal.OGRGeometry.coord_dim`` is deprecated. Use
+ :meth:`~django.contrib.gis.gdal.OGRGeometry.set_3d` instead.
+
Features removed in 5.1
=======================