From 43523217a37c7306d06cb82930bfccc76ff772dc Mon Sep 17 00:00:00 2001 From: raphacosta27 Date: Thu, 14 May 2020 05:40:27 -0700 Subject: [PATCH] DOC: Adding geopandas.Series overlaps method in documentation (#1423) --- doc/source/reference.rst | 2 ++ geopandas/base.py | 9 ++++++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/doc/source/reference.rst b/doc/source/reference.rst index 3617a3f..714c0b6 100644 --- a/doc/source/reference.rst +++ b/doc/source/reference.rst @@ -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 diff --git a/geopandas/base.py b/geopandas/base.py index 39e1e75..6503ca7 100644 --- a/geopandas/base.py +++ b/geopandas/base.py @@ -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):