From 434b78070fc2d656ee63b2896d605d7758481ee7 Mon Sep 17 00:00:00 2001 From: AJ Friend Date: Mon, 15 Apr 2024 18:44:03 -0700 Subject: [PATCH] improvements --- docs/api_quick.md | 30 +++++++++++++----------------- src/h3/api/basic_int/__init__.py | 8 ++++---- 2 files changed, 17 insertions(+), 21 deletions(-) diff --git a/docs/api_quick.md b/docs/api_quick.md index fce6698c..9539cc38 100644 --- a/docs/api_quick.md +++ b/docs/api_quick.md @@ -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 @@ -27,7 +23,7 @@ but we'll try to group functions in a reasonably logical manner. versions ``` -### Cells +## Cells ```{eval-rst} .. currentmodule:: h3 @@ -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. @@ -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 @@ -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 @@ -86,7 +82,7 @@ Functions relating H3 objects to geographic (lat/lng) coordinates. grid_path_cells ``` -### Edges +## Edges ```{eval-rst} .. currentmodule:: h3 @@ -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 diff --git a/src/h3/api/basic_int/__init__.py b/src/h3/api/basic_int/__init__.py index 1dcc66ad..210064ed 100644 --- a/src/h3/api/basic_int/__init__.py +++ b/src/h3/api/basic_int/__init__.py @@ -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 ---------- @@ -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 @@ -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 @@ -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