From f048c4b8d1bf06ffb9485e6bc5a18d46628937da Mon Sep 17 00:00:00 2001 From: Russ Date: Wed, 10 Mar 2021 17:41:37 -0800 Subject: [PATCH] Fix docstring and update version number (#10) * Add function to get neighboring placekeys * Update documentation * Highlight that the set of neighboring placekeys is unordered in docstring * Add docstring change * Update version number --- placekey/__version__.py | 2 +- placekey/placekey.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/placekey/__version__.py b/placekey/__version__.py index 9d1ffab..6820f36 100644 --- a/placekey/__version__.py +++ b/placekey/__version__.py @@ -1 +1 @@ -__version__ = '0.0.9' +__version__ = '0.0.10' diff --git a/placekey/placekey.py b/placekey/placekey.py index 27c4747..14b436d 100644 --- a/placekey/placekey.py +++ b/placekey/placekey.py @@ -156,7 +156,7 @@ def placekey_to_h3_int(placekey): def get_neighboring_placekeys(placekey, dist=1): """ - Return the set of Placekeys whose grid distance is `<= dist` from the given + Return the unordered set of Placekeys whose grid distance is `<= dist` from the given Placekey. In this context, grid distance refers to the number of H3 cells between two H3 cells, so that neighboring cells have distance 1, neighbors of neighbors have distance 2, etc.