From 71dffd8fa0d2fd8fcf017c3904d0db29b54f34d7 Mon Sep 17 00:00:00 2001 From: Martin Fleischmann Date: Mon, 1 May 2023 21:07:10 +0200 Subject: [PATCH] DOC: add note to COINS re undirected graphs --- momepy/coins.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/momepy/coins.py b/momepy/coins.py index fc1c0c9e..f3c79346 100644 --- a/momepy/coins.py +++ b/momepy/coins.py @@ -57,6 +57,12 @@ class COINS: To get a Series encoding stroke groups: >>> stroke_attr = coins.stroke_attribute() + + Notes + ----- + The LineStrings of the ``edge_gdf`` are not expected to overlap. If you are creating + it using OSMnx, don't forget to cast the graph to undirected using + ``osmnx.get_undirected(G)`` prior converting it to a GeoDataFrame. """ def __init__(self, edge_gdf, angle_threshold=0):