From 954d63155f92d92c5fa33c30be2869a2592830ef Mon Sep 17 00:00:00 2001 From: Sergey Fedoseev Date: Fri, 13 Nov 2015 14:44:15 +0500 Subject: [PATCH] [1.8.x] Refs #25739 -- Lessened the prominence of geos.fromstr() in the docs. Backport of 97e1d2433085e01696dc2fac8bfbb9c421c82b67 from master --- docs/ref/contrib/gis/db-api.txt | 8 ++++---- docs/ref/contrib/gis/geos.txt | 10 ++++++---- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/ref/contrib/gis/db-api.txt b/docs/ref/contrib/gis/db-api.txt index 41f0217fb9..b42a47ad42 100644 --- a/docs/ref/contrib/gis/db-api.txt +++ b/docs/ref/contrib/gis/db-api.txt @@ -193,14 +193,14 @@ in southern Texas:: Then distance queries may be performed as follows:: - >>> from django.contrib.gis.geos import * + >>> from django.contrib.gis.geos import GEOSGeometry >>> from django.contrib.gis.measure import D # ``D`` is a shortcut for ``Distance`` - >>> from geoapp import SouthTexasCity + >>> from geoapp.models import SouthTexasCity # Distances will be calculated from this point, which does not have to be projected. - >>> pnt = fromstr('POINT(-96.876369 29.905320)', srid=4326) + >>> pnt = GEOSGeometry('POINT(-96.876369 29.905320)', srid=4326) # If numeric parameter, units of field (meters in this case) are assumed. >>> qs = SouthTexasCity.objects.filter(point__distance_lte=(pnt, 7000)) - # Find all Cities within 7 km, > 20 miles away, and > 100 chains away (an obscure unit) + # Find all Cities within 7 km, > 20 miles away, and > 100 chains away (an obscure unit) >>> qs = SouthTexasCity.objects.filter(point__distance_lte=(pnt, D(km=7))) >>> qs = SouthTexasCity.objects.filter(point__distance_gte=(pnt, D(mi=20))) >>> qs = SouthTexasCity.objects.filter(point__distance_gte=(pnt, D(chain=100))) diff --git a/docs/ref/contrib/gis/geos.txt b/docs/ref/contrib/gis/geos.txt index 6fdad4e72c..c07d79381b 100644 --- a/docs/ref/contrib/gis/geos.txt +++ b/docs/ref/contrib/gis/geos.txt @@ -65,11 +65,10 @@ created by passing in the X and Y coordinates into its constructor:: >>> from django.contrib.gis.geos import Point >>> pnt = Point(5, 23) -Finally, there are :func:`fromstr` and :func:`fromfile` factory methods, which -return a :class:`GEOSGeometry` object from an input string or a file:: +Finally, there is the :func:`fromfile` factory method which returns a +:class:`GEOSGeometry` object from a file:: - >>> from django.contrib.gis.geos import fromstr, fromfile - >>> pnt = fromstr('POINT(5 23)') + >>> from django.contrib.gis.geos import fromfile >>> pnt = fromfile('/path/to/pnt.wkt') >>> pnt = fromfile(open('/path/to/pnt.wkt')) @@ -814,6 +813,9 @@ Example:: :type srid: int :rtype: a :class:`GEOSGeometry` corresponding to the spatial data in the string +``fromstr(string, srid)`` is equivalent to :class:`GEOSGeometry(string, srid) +`. + Example:: >>> from django.contrib.gis.geos import fromstr