David's comments

uber · Oct 27, 2024 · 0997aae · 0997aae
1 parent d5c856c
commit 0997aae
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/website/docs/api/directededge.mdx b/website/docs/api/directededge.mdx
@@ -416,7 +416,6 @@ The origin and destination are placed at
 
 Returns 0 (`E_SUCCESS`) on success.
 
-
 </TabItem>
 <TabItem value="java">
 

diff --git a/website/docs/api/hierarchy.mdx b/website/docs/api/hierarchy.mdx
@@ -493,9 +493,9 @@ $ h3 childPosToCell -p 42 -c 85283473fffffff -r 7
 
 ## compactCells
 
-Compacts the set `cellSet` of indexes as best as possible, into the array `compactedSet`.
-`compactedSet` must be at least the size of `cellSet` in case the set cannot be compacted.
-Cells in `cellSet` must all share the same resolution.
+Compacts a collection of H3 cells by recursively replacing children cells
+with their parents if all children are present.
+Input cells must all share the same resolution.
 
 <Tabs
   groupId="language"
@@ -514,6 +514,9 @@ Cells in `cellSet` must all share the same resolution.
 H3Error compactCells(const H3Index *cellSet, H3Index *compactedSet, const int64_t numCells);
 ```
 
+Compacts `cellSet` into the array `compactedSet`.
+`compactedSet` must be at least the size of `cellSet` (in case the set cannot be compacted).
+
 Returns 0 (`E_SUCCESS`) on success.
 
 </TabItem>

diff --git a/website/docs/api/inspection.mdx b/website/docs/api/inspection.mdx
@@ -217,8 +217,6 @@ The H3 CLI supports only the string representation of an H3 index.
 ## h3ToString
 
 Converts the `H3Index` representation of the index to the string representation.
-`str` must be at least of length 17.
-
 
 <Tabs
   groupId="language"
@@ -237,6 +235,7 @@ Converts the `H3Index` representation of the index to the string representation.
 H3Error h3ToString(H3Index h, char *str, size_t sz);
 ```
 
+`str` must be at least of length 17.
 Returns 0 (`E_SUCCESS`) on success.
 
 </TabItem>