docs: update package description and update benchmark

stdlib-js · steff456 · Sep 13, 2023 · Nov 7, 2023 · Nov 7, 2023 · Nov 7, 2023
commit 5f56e1decc783afcf80ecae9614148d392657689
diff --git a/lib/node_modules/@stdlib/string/base/truncate-code-points/README.md b/lib/node_modules/@stdlib/string/base/truncate-code-points/README.md
@@ -32,7 +32,7 @@ var truncateCodePoints = require( '@stdlib/string/base/truncate-code-points' );
 
 #### truncateCodePoints( str, len, ending )
 
-Truncates the code points of a provided string in order to return a string having a specified length.
+Truncates the Unicode code points of a provided string in order to return a string having a specified length.
 
 ```javascript
 var out = truncateCodePoints( 'beep boop', 7, '...' );

diff --git a/lib/node_modules/@stdlib/string/base/truncate-code-points/benchmark/benchmark.js b/lib/node_modules/@stdlib/string/base/truncate-code-points/benchmark/benchmark.js
@@ -42,7 +42,7 @@ bench( pkg, function benchmark( b ) {
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		out = truncate( values[ i%values.length ], 1, '...' );
+		out = truncate( values[ i%values.length ], 7, '...' );
 		if ( typeof out !== 'string' ) {
 			b.fail( 'should return a string' );
 		}

diff --git a/lib/node_modules/@stdlib/string/base/truncate-code-points/docs/repl.txt b/lib/node_modules/@stdlib/string/base/truncate-code-points/docs/repl.txt
@@ -1,7 +1,7 @@
 
 {{alias}}( str, len, ending )
-    Truncate the code points of a provided string in order to return a string
-    having a specified length.
+    Truncate the Unicode code points of a provided string in order to return a
+    string having a specified length.
 
     Parameters
     ----------

diff --git a/lib/node_modules/@stdlib/string/base/truncate-code-points/docs/types/index.d.ts b/lib/node_modules/@stdlib/string/base/truncate-code-points/docs/types/index.d.ts
@@ -19,7 +19,7 @@
 // TypeScript Version: 2.0
 
 /**
-* Truncate the code points of a provided string in order to return a string having a specified length.
+* Truncate the Unicode code points of a provided string in order to return a string having a specified length.
 *
 * @param str - input string
 * @param len - output string length (including ending)

diff --git a/lib/node_modules/@stdlib/string/base/truncate-code-points/lib/index.js b/lib/node_modules/@stdlib/string/base/truncate-code-points/lib/index.js
@@ -19,7 +19,7 @@
 'use strict';
 
 /**
-* Truncate the code points of a provided string in order to return a string having a specified length.
+* Truncate the Unicode code points of a provided string in order to return a string having a specified length.
 *
 * @module @stdlib/string/base/truncate-code-points
 *

diff --git a/lib/node_modules/@stdlib/string/base/truncate-code-points/lib/main.js b/lib/node_modules/@stdlib/string/base/truncate-code-points/lib/main.js
@@ -32,7 +32,7 @@ var RE_UTF16_HIGH_SURROGATE = /[\uD800-\uDBFF]/; // TODO: replace with stdlib pk
 // MAIN //
 
 /**
-* Truncates the code points of a provided string in order to return a string having a specified length.
+* Truncates the Unicode code points of a provided string in order to return a string having a specified length.
 *
 * @param {string} str - input string
 * @param {NonNegativeInteger} len - output string length (including ending)

diff --git a/lib/node_modules/@stdlib/string/base/truncate-code-points/package.json b/lib/node_modules/@stdlib/string/base/truncate-code-points/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/string/base/truncate-code-points",
   "version": "0.0.0",
-  "description": "Truncate the code points of a provided string in order to return a string having a specified length.",
+  "description": "Truncate the Unicode code points of a provided string in order to return a string having a specified length.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",