docs: update examples and remove comments

Author: kgryte

lib/node_modules/@stdlib/string/for-each/lib/index.js

@@ -26,13 +26,11 @@
 * @example
 * var forEach = require( '@stdlib/string/for-each' );
 *
-* function log( value, index, str ) {
-*     console.log( '%s: %d', index, value );
+* function log( value, index ) {
+*     console.log( '%d: %s', index, value );
 * }
 *
-* var str = 'presidential election';
-*
-* forEach( str, log );
+* forEach( 'Hello', log );
 */
 
 // MODULES //

lib/node_modules/@stdlib/string/for-each/lib/main.js

@@ -34,18 +34,16 @@ var nextGraphemeClusterBreak = require( '@stdlib/string/next-grapheme-cluster-br
 * @param {string} str - input string
 * @param {Function} clbk - function to invoke
 * @param {*} [thisArg] - execution context
-* @throws {TypeError} first argument must be a string primitive
+* @throws {TypeError} first argument must be a string
 * @throws {TypeError} second argument must be a function
 * @returns {string} input string
 *
 * @example
-* function log( value, index, str ) {
-*     console.log( '%s: %d', index, value );
+* function log( value, index ) {
+*     console.log( '%d: %s', index, value );
 * }
 *
-* var str = 'Hello';
-*
-* forEach( str, log );
+* forEach( 'Hello', log );
 */
 function forEach( str, clbk, thisArg ) {
 	var len;
@@ -57,25 +55,14 @@ function forEach( str, clbk, thisArg ) {
 	if ( !isFunction( clbk ) ) {
 		throw new TypeError( format( 'invalid argument. Second argument must be a function. Value: `%s`.', clbk ) );
 	}
-	if ( str === '' ) {
-		return '';
-	}
-
-	idx = 0;
 	len = str.length;
+	idx = 0;
 	while ( idx < len ) {
-		// Find out where the next grapheme cluster begins:
 		brk = nextGraphemeClusterBreak( str, idx );
-
-		// -1 only when end of string is reached...
-		if (brk === -1) {
+		if ( brk === -1 ) {
 			brk = len;
 		}
-
-		// Invoke the clbk on the cluster:
-		clbk.call( thisArg, str.substring(idx, brk), idx, str );
-
-		// Hop onto the beginning of the next cluster:
+		clbk.call( thisArg, str.substring( idx, brk ), idx, str );
 		idx = brk;
 	}
 	return str;