docs: fix parameter description

kgryte · kgryte · commit 38eff0a4fb0f · 2023-06-28T18:03:32.000-07:00
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
@@ -19,10 +19,10 @@
 // TypeScript Version: 2.0
 
 /**
-* Removes the first character(s) of a string.
+* Removes the first visual character(s) of a string.
 *
 * @param str - input string
-* @param n - number of characters to remove (default: 1)
+* @param n - number of characters to return (default: 1)
 * @returns updated string
 *
 * @example

Original file line number	Diff line number	Diff line change
`@@ -19,10 +19,10 @@`
`19`	`19`	`// TypeScript Version: 2.0`
`20`	`20`
`21`	`21`	`/**`
`22`		`-* Removes the first character(s) of a string.`
	`22`	`+* Removes the first visual character(s) of a string.`
`23`	`23`	`*`
`24`	`24`	`* @param str - input string`
`25`		`-* @param n - number of characters to remove (default: 1)`
	`25`	`+* @param n - number of characters to return (default: 1)`
`26`	`26`	`* @returns updated string`
`27`	`27`	`*`
`28`	`28`	`* @example`