change per review

Author: isaacbrodsky

src/apps/filters/h3.c

@@ -319,13 +319,13 @@ SUBCOMMAND(getReservedBits,
 SUBCOMMAND(getIndexDigit,
            "Extracts the indexing digit (0 - 7) from the H3 cell") {
     DEFINE_CELL_ARG(cell, cellArg);
-    int digit = 0;
-    Arg digitArg = {.names = {"-d", "--digit"},
+    int res = 0;
+    Arg digitArg = {.names = {"-r", "--res"},
                     .required = true,
                     .scanFormat = "%d",
-                    .valueName = "digit",
-                    .value = &digit,
-                    .helpText = "Indexing digit (1 - 15)"};
+                    .valueName = "res",
+                    .value = &res,
+                    .helpText = "Indexing resolution (1 - 15)"};
     Arg *args[] = {&getIndexDigitArg, &helpArg, &cellArg, &digitArg};
     PARSE_SUBCOMMAND(argc, argv, args);
     // TODO: Should there be a general `isValidIndex`?
@@ -336,7 +336,7 @@ SUBCOMMAND(getIndexDigit,
         return cellErr;
     }
     int value;
-    H3Error err = H3_EXPORT(getIndexDigit)(cell, digit, &value);
+    H3Error err = H3_EXPORT(getIndexDigit)(cell, res, &value);
     if (err) {
         return err;
     }

src/apps/fuzzers/fuzzerCellProperties.c

@@ -24,7 +24,7 @@
 typedef struct {
     H3Index index;
     H3Index mask;
-    int digit;
+    int res;
 } inputArgs;
 
 int LLVMFuzzerTestOneInput(const uint8_t *data, size_t size) {
@@ -49,7 +49,7 @@ int LLVMFuzzerTestOneInput(const uint8_t *data, size_t size) {
     }
 
     int digitOut;
-    H3_EXPORT(getIndexDigit)(args->index, args->digit, &digitOut);
+    H3_EXPORT(getIndexDigit)(args->index, args->res, &digitOut);
 
     return 0;
 }

src/h3lib/include/h3api.h.in

@@ -533,7 +533,7 @@ DECLSPEC int H3_EXPORT(getReservedBits)(H3Index h);
 /** @brief returns the indexing digit of the provided H3 cell
  *
  * Indexing digits are 1-indexed beginning with the digit for resolution 1. */
-DECLSPEC H3Error H3_EXPORT(getIndexDigit)(H3Index h, int digit, int *out);
+DECLSPEC H3Error H3_EXPORT(getIndexDigit)(H3Index h, int res, int *out);
 /** @} */
 
 /** @defgroup stringToH3 stringToH3

src/h3lib/lib/h3Index.c

@@ -98,27 +98,26 @@ int H3_EXPORT(getBaseCellNumber)(H3Index h) { return H3_GET_BASE_CELL(h); }
 int H3_EXPORT(getReservedBits)(H3Index h) { return H3_GET_RESERVED_BITS(h); }
 
 /**
- * Returns the index digits at `digit`, which starts with 1 for resolution
+ * Returns the index digit at `res`, which starts with 1 for resolution
  * 1.
  *
- * 0 is not a valid value for `digit` because resolution 0 is specified by
+ * 0 is not a valid value for `res` because resolution 0 is specified by
  * the base cell number, not an indexing digit.
  *
- * `digit` may exceed the actual resolution of the index, in which case
+ * `res` may exceed the actual resolution of the index, in which case
  * the actual digit stored in the index is returned. For valid cell indexes
  * this will be 7.
  *
  * @param h The H3 index (e.g. cell).
- * @param digit Which indexing digit to retrieve, starting with 1.
+ * @param res Which indexing digit to retrieve, starting with 1.
  * @param out Receives the value of the indexing digit.
  * @return 0 (E_SUCCESS) on success, or another value otherwise.
  */
-H3Error H3_EXPORT(getIndexDigit)(H3Index h, int digit, int *out) {
-    if (digit < 1 || digit > MAX_H3_RES) {
-        // Not strictly a resolution domain but close enough
+H3Error H3_EXPORT(getIndexDigit)(H3Index h, int res, int *out) {
+    if (res < 1 || res > MAX_H3_RES) {
         return E_RES_DOMAIN;
     }
-    *out = H3_GET_INDEX_DIGIT(h, digit);
+    *out = H3_GET_INDEX_DIGIT(h, res);
     return E_SUCCESS;
 }
 

website/docs/api/inspection.mdx

@@ -296,51 +296,51 @@ Works for cells, edges and vertexes.
 <TabItem value="c">
 
 ```c
-H3Error getIndexDigit(H3Index h, int digit, H3Index *out);
+H3Error getIndexDigit(H3Index h, int res, H3Index *out);
 ```
 
 </TabItem>
 <TabItem value="java">
 
 ```java
-int getIndexDigit(long h3, int digit);
-int getIndexDigit(String h3Address, int digit);
+int getIndexDigit(long h3, int res);
+int getIndexDigit(String h3Address, int res);
 ```
 
 </TabItem>
 <TabItem value="javascript">
 
 ```js
-h3.getIndexDigit(h, digit)
+h3.getIndexDigit(h, res)
 ```
 
 ```js live
 function example() {
   const h = '85283473fffffff';
-  const digit = 2;
-  return h3.getIndexDigit(h, digit);
+  const res = 2;
+  return h3.getIndexDigit(h, res);
 }
 ```
 
 </TabItem>
 <TabItem value="python">
 
 ```py
-h3.get_index_digit(h, digit)
+h3.get_index_digit(h, res)
 ```
 
 </TabItem>
 <TabItem value="go">
 
 ```go
-cell.IndexDigit(digit)
+cell.IndexDigit(res)
 ```
 
 </TabItem>
 <TabItem value="duckdb">
 
 ```sql
-h3_get_index_digit(h, digit)
+h3_get_index_digit(h, res)
 ```
 
 </TabItem>
@@ -354,11 +354,11 @@ H3 4.3.0
 	getIndexDigit	Extracts the indexing digit (0 - 7) from the H3 cell
 	-h, --help	Show this help message.
 	-c, --cell <index>	Required. H3 Cell
-	-d, --digit <digit>	Required. Indexing digit (1 - 15)
+	-r, --res <res>	Required. Indexing resolution (1 - 15)
 ```
 
 ```bash
-$ h3 getIndexDigit -c 85283473fffffff -d 2
+$ h3 getIndexDigit -c 85283473fffffff -r 2
 7
 ```