DOC: Adding geopandas.Series overlaps method in documentation (#1423)

This commit is contained in:
raphacosta27
2020-05-14 13:40:27 +01:00
committed by GitHub
parent 2c22a26bd4
commit 43523217a3
2 changed files with 10 additions and 1 deletions
+2
View File
@@ -53,6 +53,8 @@ The following Shapely methods and attributes are available on
.. automethod:: geopandas.GeoSeries.intersects
.. automethod:: geopandas.GeoSeries.overlaps
.. automethod:: geopandas.GeoSeries.touches
.. automethod:: geopandas.GeoSeries.within
+8 -1
View File
@@ -374,7 +374,14 @@ class GeoPandasBase(object):
return _binary_op("intersects", self, other)
def overlaps(self, other):
"""Return True for all geometries that overlap *other*, else False"""
"""Returns True for all geometries that overlap *other*, else False.
Parameters
----------
other : GeoSeries or geometric object
The GeoSeries (elementwise) or geometric object to test if
overlaps.
"""
return _binary_op("overlaps", self, other)
def touches(self, other):