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 · Mar 11, 2021 · f048c4b · f048c4b
1 parent 4b7d237
commit f048c4b
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git 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
@@ -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.