diff options
| author | Sergey Fedoseev <fedoseev.sergey@gmail.com> | 2017-11-24 22:30:53 +0500 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2017-12-27 19:26:14 -0500 |
| commit | aefe624c62639c189845803f0935fc29e20b5fb8 (patch) | |
| tree | 01c1dd7922645a1ac68f0eb3ca4f45dc9ec68834 /docs | |
| parent | 44908d4d9360f72b9511aa0a878458285ba326d4 (diff) | |
Fixed #28841 -- Added ForcePolygonCW GIS function and deprecated ForceRHR.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/internals/deprecation.txt | 2 | ||||
| -rw-r--r-- | docs/ref/contrib/gis/functions.txt | 39 | ||||
| -rw-r--r-- | docs/releases/2.1.txt | 3 |
3 files changed, 33 insertions, 11 deletions
diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt index 1b7d5f73a9..248a0c642e 100644 --- a/docs/internals/deprecation.txt +++ b/docs/internals/deprecation.txt @@ -29,6 +29,8 @@ details on these changes. * The ``field_name`` keyword argument of ``QuerySet.earliest()`` and ``latest()`` will be removed. +* ``django.contrib.gis.db.models.functions.ForceRHR`` will be removed. + See the :ref:`Django 2.1 release notes <deprecated-features-2.1>` for more details on these changes. diff --git a/docs/ref/contrib/gis/functions.txt b/docs/ref/contrib/gis/functions.txt index 66099c3317..fe8239d467 100644 --- a/docs/ref/contrib/gis/functions.txt +++ b/docs/ref/contrib/gis/functions.txt @@ -20,17 +20,18 @@ get a ``NotImplementedError`` exception. Function's summary: -================== ======================== ====================== =================== ================== ===================== -Measurement Relationships Operations Editors Output format Miscellaneous -================== ======================== ====================== =================== ================== ===================== -:class:`Area` :class:`Azimuth` :class:`Difference` :class:`ForceRHR` :class:`AsGeoJSON` :class:`IsValid` -:class:`Distance` :class:`BoundingCircle` :class:`Intersection` :class:`MakeValid` :class:`AsGML` :class:`MemSize` -:class:`Length` :class:`Centroid` :class:`SymDifference` :class:`Reverse` :class:`AsKML` :class:`NumGeometries` -:class:`Perimeter` :class:`Envelope` :class:`Union` :class:`Scale` :class:`AsSVG` :class:`NumPoints` -.. :class:`LineLocatePoint` :class:`SnapToGrid` :class:`GeoHash` -.. :class:`PointOnSurface` :class:`Transform` +================== ======================== ====================== ======================= ================== ===================== +Measurement Relationships Operations Editors Output format Miscellaneous +================== ======================== ====================== ======================= ================== ===================== +:class:`Area` :class:`Azimuth` :class:`Difference` :class:`ForcePolygonCW` :class:`AsGeoJSON` :class:`IsValid` +:class:`Distance` :class:`BoundingCircle` :class:`Intersection` :class:`ForceRHR` :class:`AsGML` :class:`MemSize` +:class:`Length` :class:`Centroid` :class:`SymDifference` :class:`MakeValid` :class:`AsKML` :class:`NumGeometries` +:class:`Perimeter` :class:`Envelope` :class:`Union` :class:`Reverse` :class:`AsSVG` :class:`NumPoints` +.. :class:`LineLocatePoint` :class:`Scale` :class:`GeoHash` +.. :class:`PointOnSurface` :class:`SnapToGrid` +.. :class:`Transform` .. :class:`Translate` -================== ======================== ====================== =================== ================== ===================== +================== ======================== ====================== ======================= ================== ===================== ``Area`` ======== @@ -271,11 +272,29 @@ SpatiaLite Accepts a single geographic field or expression and returns the geometry representing the bounding box of the geometry. +``ForcePolygonCW`` +================== + +.. class:: ForcePolygonCW(expression, **extra) + +.. versionadded:: 2.1 + +*Availability*: `PostGIS <https://postgis.net/docs/ST_ForcePolygonCW.html>`__ + +Accepts a single geographic field or expression and returns a modified version +of the polygon/multipolygon in which all exterior rings are oriented clockwise +and all interior rings are oriented counterclockwise. Non-polygonal geometries +are returned unchanged. + ``ForceRHR`` ============ .. class:: ForceRHR(expression, **extra) +.. deprecated:: 2.1 + + Use :class:`ForcePolygonCW` instead. + *Availability*: `PostGIS <https://postgis.net/docs/ST_ForceRHR.html>`__ Accepts a single geographic field or expression and returns a modified version diff --git a/docs/releases/2.1.txt b/docs/releases/2.1.txt index 9d090b8244..bf69a59762 100644 --- a/docs/releases/2.1.txt +++ b/docs/releases/2.1.txt @@ -239,7 +239,8 @@ Features deprecated in 2.1 Miscellaneous ------------- -* ... +* The ``ForceRHR`` GIS function is deprecated in favor of the new + :class:`~django.contrib.gis.db.models.functions.ForcePolygonCW` function. .. _removed-features-2.1: |