From 54f46c4e86060e76925988a0d167cd84a7f72ce0 Mon Sep 17 00:00:00 2001 From: Isaac Brodsky Date: Thu, 31 Aug 2023 09:14:04 -0700 Subject: [PATCH] Docs: Res0 cells are by definition at res 0 (#781) --- website/docs/api/misc.mdx | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/website/docs/api/misc.mdx b/website/docs/api/misc.mdx index 1d6e6b15c..f3a1cd9bc 100644 --- a/website/docs/api/misc.mdx +++ b/website/docs/api/misc.mdx @@ -712,35 +712,36 @@ H3Error getRes0Cells(H3Index *out); ```py -h3.get_res0_cells(res) +h3.get_res0_cells() ``` ```java -Collection getRes0Cells(int res); -Collection getRes0CellAddresses(int res); +Collection getRes0Cells(); +Collection getRes0CellAddresses(); ``` ```js -h3.getRes0Cells(res) +h3.getRes0Cells() ``` ```js live function example() { - const res = 5; - return h3.getRes0Cells(res); + return h3.getRes0Cells(); } ``` -All the resolution 0 H3 indexes. +All the resolution `0` H3 cell indexes. These are the coarsest cells that can be represented in the H3 system and are the +parents of all other cell indexes in the H3 grid system. The returned indexes correspond with the 122 base cells. + `out` must be an array of at least size `res0CellCount()`. ## res0CellCount @@ -791,7 +792,7 @@ This function exists for memory management and is not exposed. -Number of resolution 0 H3 indexes, which is defined as 122. +Number of resolution `0` H3 indexes, which is defined as 122. ## getPentagons