Skip to content

Commit

Permalink
improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
ajfriend committed Apr 16, 2024
1 parent af03c91 commit 434b780
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 21 deletions.
30 changes: 13 additions & 17 deletions docs/api_quick.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,16 @@
# API Quick Reference

This page lists the functions that are common to each of the
We list the functions that are shared between the
[provided APIs](api_comparison).
The APIs differ only in their input/output types
(e.g., `int` vs. `str` or `set` vs `numpy.array`).
(e.g., `int` vs. `str` or `list` vs `numpy.array`).

These functions align with those explained in the
[core H3 documentation](https://h3geo.org/docs/api/indexing).
These functions correspond to those explained in the
[H3 C library documentation](https://h3geo.org/docs/api/indexing),
and should be generally aligned with the
[other language bindings](https://h3geo.org/docs/community/bindings).

## Summaries

There is no strict hierarchy for H3 functions,
but we'll try to group functions in a reasonably logical manner.


### Identification
## Identification

```{eval-rst}
.. currentmodule:: h3
Expand All @@ -27,7 +23,7 @@ but we'll try to group functions in a reasonably logical manner.
versions
```

### Cells
## Cells

```{eval-rst}
.. currentmodule:: h3
Expand All @@ -45,7 +41,7 @@ but we'll try to group functions in a reasonably logical manner.
uncompact_cells
```

### Geographic coordinates
## Geographic coordinates

Functions relating H3 objects to geographic (lat/lng) coordinates.

Expand All @@ -62,7 +58,7 @@ Functions relating H3 objects to geographic (lat/lng) coordinates.
directed_edge_to_boundary
```

### Hierarchical relationships
## Hierarchical relationships

```{eval-rst}
.. currentmodule:: h3
Expand All @@ -73,7 +69,7 @@ Functions relating H3 objects to geographic (lat/lng) coordinates.
cell_to_center_child
```

### Cell grid relationships
## Cell grid relationships

```{eval-rst}
.. currentmodule:: h3
Expand All @@ -86,7 +82,7 @@ Functions relating H3 objects to geographic (lat/lng) coordinates.
grid_path_cells
```

### Edges
## Edges

```{eval-rst}
.. currentmodule:: h3
Expand All @@ -99,7 +95,7 @@ Functions relating H3 objects to geographic (lat/lng) coordinates.
get_directed_edge_origin
```

### IJ-indexing
## IJ-indexing

```{eval-rst}
.. currentmodule:: h3
Expand Down
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 @@ -258,7 +258,7 @@ def cell_to_boundary(h):
def grid_disk(h, k=1):
"""
Return unordered collection of cells with H3 distance ``<= k`` from ``h``.
That is, the 'filled-in' disk.
That is, the "filled-in" disk.
Parameters
----------
Expand Down Expand Up @@ -900,7 +900,7 @@ def cell_area(h, unit='km^2'):
----------
h : H3Cell
unit: str
Unit for area result (``'km^2'``, 'm^2', or 'rads^2')
Unit for area result (``'km^2'``, ``'m^2'``, or ``'rads^2'``)
Returns
Expand Down Expand Up @@ -928,7 +928,7 @@ def edge_length(e, unit='km'):
----------
h : H3Cell
unit: str
Unit for length result ('km', 'm', or 'rads')
Unit for length result (``'km'``, ``'m'``, or ``'rads'``)
Returns
Expand Down Expand Up @@ -960,7 +960,7 @@ def great_circle_distance(latlng1, latlng2, unit='km'):
latlng2 : tuple
(lat, lng) tuple in degrees
unit: str
Unit for distance result ('km', 'm', or 'rads')
Unit for distance result (``'km'``, ``'m'``, or ``'rads'``)
Returns
Expand Down

0 comments on commit 434b780

Please sign in to comment.