Commit 013309ea authored by Sergey Fedoseev's avatar Sergey Fedoseev Committed by Tim Graham
Browse files

[1.9.x] Refs #25739 -- Lessened the prominence of geos.fromstr() in the docs.

Backport of 97e1d243 from master
parent 8edf8db5
Loading
Loading
Loading
Loading
+2 −2
Original line number Diff line number Diff line
@@ -229,11 +229,11 @@ in southern Texas::

Then distance queries may be performed as follows::

    >>> from django.contrib.gis.geos import fromstr
    >>> from django.contrib.gis.geos import GEOSGeometry
    >>> from django.contrib.gis.measure import D # ``D`` is a shortcut for ``Distance``
    >>> 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)
+6 −4
Original line number Diff line number Diff line
@@ -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'))

@@ -804,6 +803,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)
<GEOSGeometry>`.

Example::

    >>> from django.contrib.gis.geos import fromstr