Skip to content

Commit a177ffa

Browse files
committed
[docs] Improve phrasing of doc entry about transform parameter
1 parent 9674573 commit a177ffa

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,15 @@ This field takes four optional arguments:
9797
- ``auto_bbox``: If ``True``, the GeoJSON object will include
9898
a `bounding box <https://datatracker.ietf.org/doc/html/rfc7946#section-5>`_,
9999
which is the smallest possible rectangle enclosing the geometry.
100-
- ``transform`` (defaults to ``None``): If ``None`` (or the input geometry does not have
101-
a SRID), the GeoJSON's coordinates will not be transformed. If any other `spatial
102-
reference <https://docs.djangoproject.com/en/5.0/ref/contrib/gis/geos/#django.contrib.gis.geos.GEOSGeometry.transform>`,
103-
the GeoJSON's coordinates will be transformed correspondingly.
100+
- ``transform`` (defaults to ``None``): Can be set to any value that is accepted by
101+
|GEOSGeometry.transform|_. Set to `4326` if your input geometries are in another
102+
projection and you want to produce output according to the `GeoJSON standard
103+
<https://datatracker.ietf.org/doc/html/rfc7946#section-4>`_. If ``None`` (or the
104+
input geometries do not have a SRID), the output coordinates will not be
105+
transformed.
106+
107+
.. |GEOSGeometry.transform| replace:: ``GEOSGeometry.transform``
108+
.. _GEOSGeometry.transform: https://example.org
104109

105110
**Note:** While ``precision`` and ``remove_duplicates`` are designed to reduce the
106111
byte size of the API response, they will also increase the processing time

0 commit comments

Comments
 (0)