diff options
| author | Tom Dyson <tom@torchbox.com> | 2014-07-25 01:24:52 +0100 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2014-07-25 06:22:36 -0400 |
| commit | 2127b6fe9918dc51b6d170fef6eed7f42485436d (patch) | |
| tree | 335141cfe06e33357656e4ae713d50311e876721 | |
| parent | ce95ab8f025cc9f35990f0c2d9a290eec1ece753 (diff) | |
[1.7.x] Improved docs for GEOSGeometry.simplify()
Backport of aa8bc7fa7d from master
| -rw-r--r-- | docs/ref/contrib/gis/geos.txt | 17 |
1 files changed, 8 insertions, 9 deletions
diff --git a/docs/ref/contrib/gis/geos.txt b/docs/ref/contrib/gis/geos.txt index 0e4834c407..db9d04099d 100644 --- a/docs/ref/contrib/gis/geos.txt +++ b/docs/ref/contrib/gis/geos.txt @@ -440,17 +440,16 @@ topological relationship between this geometry and the other. .. method:: GEOSGeometry.simplify(tolerance=0.0, preserve_topology=False) -Returns a new :class:`GEOSGeometry`, simplified using the Douglas-Peucker -algorithm to the specified tolerance. A higher tolerance value implies -less points in the output. If no tolerance is tolerance provided, -it defaults to 0. +Returns a new :class:`GEOSGeometry`, simplified to the specified tolerance +using the Douglas-Peucker algorithm. A higher tolerance value implies +fewer points in the output. If no tolerance is provided, it defaults to 0. -By default, this function does not preserve topology - e.g., -:class:`Polygon` objects can be split, collapsed into lines or disappear. -:class:`Polygon` holes can be created or disappear, and lines can cross. +By default, this function does not preserve topology. For example, +:class:`Polygon` objects can be split, be collapsed into lines, or disappear. +:class:`Polygon` holes can be created or disappear, and lines may cross. By specifying ``preserve_topology=True``, the result will have the same -dimension and number of components as the input, however, this is -significantly slower. +dimension and number of components as the input; this is significantly +slower, however. .. method:: GEOSGeometry.sym_difference(other) |