Skip to content

Commit

Permalink
"grid distance" is better than "H3 distance"
Browse files Browse the repository at this point in the history
  • Loading branch information
ajfriend committed Apr 16, 2024
1 parent 304ce78 commit e330766
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/h3/api/basic_int/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -214,9 +214,9 @@ def cell_to_parent(h, res=None):

def grid_distance(h1, h2):
"""
Compute the H3 distance between two cells.
Compute the grid distance between two cells.
The H3 distance is defined as the length of the shortest
The grid distance is defined as the length of the shortest
path between the cells in the graph formed by connecting
adjacent cells.
Expand Down Expand Up @@ -257,7 +257,7 @@ def cell_to_boundary(h):

def grid_disk(h, k=1):
"""
Return unordered collection of cells with H3 distance ``<= k`` from ``h``.
Return unordered collection of cells with grid distance ``<= k`` from ``h``.
That is, the "filled-in" disk.
Parameters
Expand All @@ -281,7 +281,7 @@ def grid_disk(h, k=1):

def grid_ring(h, k=1):
"""
Return unordered collection of cells with H3 distance ``== k`` from ``h``.
Return unordered collection of cells with grid distance ``== k`` from ``h``.
That is, the "hollow" ring.
Parameters
Expand Down

0 comments on commit e330766

Please sign in to comment.