docs: update option description

kgryte · kgryte · commit 49420b414146 · 2023-07-18T14:53:12.000-07:00
diff --git a/lib/node_modules/@stdlib/string/first/README.md b/lib/node_modules/@stdlib/string/first/README.md
@@ -47,7 +47,7 @@ The function supports the following options:
 -   **mode**: type of characters to return. Must be one of the following:
 
     -   `'grapheme'`: grapheme clusters. Appropriate for strings containing visual characters which can span multiple Unicode code points (e.g., emoji).
-    -   `'code_point'`: Unicode code points. Appropriate for strings containing visual characters which are comprised of more than one Unicode code unit.
+    -   `'code_point'`: Unicode code points. Appropriate for strings containing visual characters which are comprised of more than one Unicode code unit (e.g., ideographic symbols and punctuation and mathematical alphanumerics).
     -   `'code_unit'`: UTF-16 code units. Appropriate for strings containing visual characters drawn from the basic multilingual plane (BMP) (e.g., common characters, such as those from the Latin, Greek, and Cyrillic alphabets).
     
     Default: `'grapheme'`.
diff --git a/lib/node_modules/@stdlib/string/first/docs/repl.txt b/lib/node_modules/@stdlib/string/first/docs/repl.txt
@@ -20,7 +20,8 @@
           characters which can span multiple Unicode code points (e.g., emoji).
         - code_point: Unicode code points. Appropriate for strings containing
           visual characters which are comprised of more than one Unicode code
-          unit.
+          unit (e.g., ideographic symbols and punctuation and mathematical
+          alphanumerics).
         - code_unit': UTF-16 code units. Appropriate for strings containing
           visual characters drawn from the basic multilingual plane (BMP) (e.g.,
           common characters, such as those from the Latin, Greek, and Cyrillic
diff --git a/lib/node_modules/@stdlib/string/first/docs/types/index.d.ts b/lib/node_modules/@stdlib/string/first/docs/types/index.d.ts
@@ -32,7 +32,7 @@ interface Options {
 	* -   The following option values are supported:
 	*
 	*     -   `'grapheme'`: grapheme clusters. Appropriate for strings containing visual characters which can span multiple Unicode code points (e.g., emoji).
-	*     -   `'code_point'`: Unicode code points. Appropriate for strings containing visual characters which are comprised of more than one Unicode code unit.
+	*     -   `'code_point'`: Unicode code points. Appropriate for strings containing visual characters which are comprised of more than one Unicode code unit (e.g., ideographic symbols and punctuation and mathematical alphanumerics).
 	*     -   `'code_unit'`: UTF-16 code units. Appropriate for strings containing visual characters drawn from the basic multilingual plane (BMP) (e.g., common characters, such as those from the Latin, Greek, and Cyrillic alphabets).
 	*/
 	mode?: 'grapheme' | 'code_point' | 'code_unit';

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ interface Options {`
`32`	`32`	`* - The following option values are supported:`
`33`	`33`	`*`
`34`	`34`	* - `'grapheme'`: grapheme clusters. Appropriate for strings containing visual characters which can span multiple Unicode code points (e.g., emoji).
`35`		- * - `'code_point'`: Unicode code points. Appropriate for strings containing visual characters which are comprised of more than one Unicode code unit.
	`35`	+ * - `'code_point'`: Unicode code points. Appropriate for strings containing visual characters which are comprised of more than one Unicode code unit (e.g., ideographic symbols and punctuation and mathematical alphanumerics).
`36`	`36`	* - `'code_unit'`: UTF-16 code units. Appropriate for strings containing visual characters drawn from the basic multilingual plane (BMP) (e.g., common characters, such as those from the Latin, Greek, and Cyrillic alphabets).
`37`	`37`	`*/`
`38`	`38`	`mode?: 'grapheme' \| 'code_point' \| 'code_unit';`