Minor clean-up and add missing return documentation

Planeshifter · Planeshifter · commit 7a19cd41955d · 2021-02-16T23:31:22.000-05:00
diff --git a/lib/node_modules/@stdlib/regexp/decimal-number/docs/repl.txt b/lib/node_modules/@stdlib/regexp/decimal-number/docs/repl.txt
@@ -18,6 +18,11 @@
         Boolean indicating whether to create a capture group for the match.
         Default: false.
 
+    Returns
+    -------
+    re: RegExp
+        Regular expression.
+
     Examples
     --------
     > var RE = {{alias}}();
diff --git a/lib/node_modules/@stdlib/regexp/decimal-number/lib/validate.js b/lib/node_modules/@stdlib/regexp/decimal-number/lib/validate.js
@@ -41,7 +41,7 @@ var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
 * @example
 * var opts = {};
 * var options = {
-*     'returns': '*'
+*     'flags': 'gm'
 * };
 * var err = validate( opts, options );
 * if ( err ) {
diff --git a/lib/node_modules/@stdlib/regexp/eol/docs/repl.txt b/lib/node_modules/@stdlib/regexp/eol/docs/repl.txt
@@ -14,6 +14,11 @@
         Boolean indicating whether to wrap a regular expression matching a white
         space character with a capture group. Default: false.
 
+    Returns
+    -------
+    regexp: RegExp
+        Regular expression.
+
     Examples
     --------
     > var RE_EOL = {{alias}}();
@@ -30,7 +35,7 @@
     Examples
     --------
     > var bool = {{alias}}.REGEXP.test( 'abc' )
-	false
+    false
 
 {{alias}}.REGEXP_CAPTURE
     Regular expression to capture a newline character sequence: /\r?\n/.
diff --git a/lib/node_modules/@stdlib/regexp/eol/docs/types/index.d.ts b/lib/node_modules/@stdlib/regexp/eol/docs/types/index.d.ts
@@ -85,7 +85,6 @@ interface ReEOL {
 * @returns regular expression
 *
 * @example
-* @example
 * var RE_EOL = reEOL();
 *
 * var bool = RE_EOL.test( '\n' );
diff --git a/lib/node_modules/@stdlib/regexp/eol/lib/validate.js b/lib/node_modules/@stdlib/regexp/eol/lib/validate.js
@@ -41,7 +41,7 @@ var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
 * @example
 * var opts = {};
 * var options = {
-*     'returns': '*'
+*     'flags': 'gm'
 * };
 * var err = validate( opts, options );
 * if ( err ) {
diff --git a/lib/node_modules/@stdlib/regexp/extended-length-path/docs/repl.txt b/lib/node_modules/@stdlib/regexp/extended-length-path/docs/repl.txt
@@ -4,6 +4,11 @@
 
     Extended-length paths are Windows paths which begin with `\\?\`.
 
+    Returns
+    -------
+    re: RegExp
+        Regular expression.
+
     Examples
     --------
     > var RE = {{alias}}();
diff --git a/lib/node_modules/@stdlib/regexp/utf16-surrogate-pair/docs/repl.txt b/lib/node_modules/@stdlib/regexp/utf16-surrogate-pair/docs/repl.txt
@@ -1,6 +1,11 @@
-{{alias}}
+{{alias}}()
     Returns a regular expression to match a UTF-16 surrogate pair.
 
+    Returns
+    -------
+    re: RegExp
+        Regular expression.
+
     Examples
     --------
     > var RE = {{alias}}();
diff --git a/lib/node_modules/@stdlib/regexp/utf16-unpaired-surrogate/docs/repl.txt b/lib/node_modules/@stdlib/regexp/utf16-unpaired-surrogate/docs/repl.txt
@@ -1,6 +1,11 @@
-{{alias}}
+{{alias}}()
     Returns a regular expression to match an unpaired UTF-16 surrogate.
 
+    Returns
+    -------
+    re: RegExp
+        Regular expression.
+
     Examples
     --------
     > var RE = {{alias}}();
diff --git a/lib/node_modules/@stdlib/regexp/whitespace/docs/repl.txt b/lib/node_modules/@stdlib/regexp/whitespace/docs/repl.txt
@@ -14,6 +14,11 @@
         Boolean indicating whether to wrap a regular expression matching a white
         space character with a capture group. Default: false.
 
+    Returns
+    -------
+    re: RegExp
+        Regular expression.
+
     Examples
     --------
     > var RE = {{alias}}();
diff --git a/lib/node_modules/@stdlib/regexp/whitespace/lib/validate.js b/lib/node_modules/@stdlib/regexp/whitespace/lib/validate.js
@@ -41,7 +41,7 @@ var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
 * @example
 * var opts = {};
 * var options = {
-*     'returns': '*'
+*     'flags': 'gm'
 * };
 * var err = validate( opts, options );
 * if ( err ) {

Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,6 @@ interface ReEOL {`
`85`	`85`	`* @returns regular expression`
`86`	`86`	`*`
`87`	`87`	`* @example`
`88`		`-* @example`
`89`	`88`	`* var RE_EOL = reEOL();`
`90`	`89`	`*`
`91`	`90`	`* var bool = RE_EOL.test( '\n' );`