chore: add notes and clean-up

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: passed
  - task: lint_repl_help
    status: passed
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: passed
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---

Author: kgryte

lib/node_modules/@stdlib/number/uint32/base/add/README.md

@@ -45,13 +45,13 @@ var add = require( '@stdlib/number/uint32/base/add' );
 Computes the sum of two unsigned 32-bit integers.
 
 ```javascript
-var v = add( 1, 5 );
+var v = add( 1>>>0, 5>>>0 );
 // returns 6
 
-v = add( 2, 5 );
+v = add( 2>>>0, 5>>>0 );
 // returns 7
 
-v = add( 0, 5 );
+v = add( 0>>>0, 5>>>0 );
 // returns 5
 ```
 

lib/node_modules/@stdlib/number/uint32/base/add/docs/repl.txt

@@ -2,13 +2,16 @@
 {{alias}}( x, y )
     Computes the sum of two unsigned 32-bit integers `x` and `y`.
 
+    The function performs C-like addition of two unsigned 32-bit integers,
+    including wraparound semantics.
+
     Parameters
     ----------
     x: integer
-        First input value.
+        First unsigned 32-bit integer.
 
     y: integer
-        Second input value.
+        Second unsigned 32-bit integer.
 
     Returns
     -------
@@ -17,11 +20,11 @@
 
     Examples
     --------
-    > var v = {{alias}}( 1, 5 )
+    > var v = {{alias}}( 1>>>0, 5>>>0 )
     6
-    > v = {{alias}}( 2, 5 )
+    > v = {{alias}}( 2>>>0, 5>>>0 )
     7
-    > v = {{alias}}( 0, 5 )
+    > v = {{alias}}( 0>>>0, 5>>>0 )
     5
 
     See Also

lib/node_modules/@stdlib/number/uint32/base/add/docs/types/index.d.ts

@@ -21,20 +21,24 @@
 /**
 * Computes the sum of two unsigned 32-bit integers `x` and `y`.
 *
+* ## Notes
+*
+* -   The function performs C-like addition of two unsigned 32-bit integers, including wraparound semantics.
+*
 * @param x - first input value
 * @param y - second input value
 * @returns sum
 *
 * @example
-* var v = add( 1, 5 );
+* var v = add( 1>>>0, 5>>>0 );
 * // returns 6
 *
 * @example
-* var v = add( 2, 5 );
+* var v = add( 2>>>0, 5>>>0 );
 * // returns 7
 *
 * @example
-* var v = add( 0, 5 );
+* var v = add( 0>>>0, 5>>>0 );
 * // returns 5
 */
 declare function add( x: number, y: number ): number;

lib/node_modules/@stdlib/number/uint32/base/add/lib/index.js

@@ -26,13 +26,13 @@
 * @example
 * var add = require( '@stdlib/number/uint32/base/add' );
 *
-* var v = add( 1, 5 );
+* var v = add( 1>>>0, 5>>>0 );
 * // returns 6
 *
-* v = add( 2, 5 );
+* v = add( 2>>>0, 5>>>0 );
 * // returns 7
 *
-* v = add( 0, 5 );
+* v = add( 0>>>0, 5>>>0 );
 * // returns 5
 */
 

lib/node_modules/@stdlib/number/uint32/base/add/lib/main.js

@@ -34,15 +34,15 @@
 * @returns {integer} sum
 *
 * @example
-* var v = add( 1, 5 );
+* var v = add( 1>>>0, 5>>>0 );
 * // returns 6
 *
 * @example
-* var v = add( 2, 5 );
+* var v = add( 2>>>0, 5>>>0 );
 * // returns 7
 *
 * @example
-* var v = add( 0, 5 );
+* var v = add( 0>>>0, 5>>>0 );
 * // returns 5
 */
 function add( x, y ) {

lib/node_modules/@stdlib/number/uint32/base/add/lib/native.js

@@ -34,15 +34,15 @@ var addon = require( './../src/addon.node' );
 * @returns {integer} sum
 *
 * @example
-* var v = add( 1, 5 );
+* var v = add( 1>>>0, 5>>>0 );
 * // returns 6
 *
 * @example
-* var v = add( 2, 5 );
+* var v = add( 2>>>0, 5>>>0 );
 * // returns 7
 *
 * @example
-* var v = add( 0, 5 );
+* var v = add( 0>>>0, 5>>>0 );
 * // returns 5
 */
 function add( x, y ) {

lib/node_modules/@stdlib/number/uint32/base/mul/README.md

@@ -18,9 +18,9 @@ limitations under the License.
 
 -->
 
-# umul
+# mul
 
-> Perform C-like multiplication of two unsigned 32-bit integers.
+> Multiply two unsigned 32-bit integers.
 
 <section class="intro">
 
@@ -33,18 +33,18 @@ limitations under the License.
 ## Usage
 
 ```javascript
-var umul = require( '@stdlib/number/uint32/base/mul' );
+var mul = require( '@stdlib/number/uint32/base/mul' );
 ```
 
-#### umul( a, b )
+#### mul( x, y )
 
-Performs C-like multiplication of two unsigned 32-bit integers.
+Multiplies two unsigned 32-bit integers.
 
 ```javascript
-var v = umul( 10>>>0, 4>>>0 );
+var v = mul( 10>>>0, 4>>>0 );
 // returns 40
 
-v = umul( 2147483648>>>0, 5>>>0 ); // 2^31 * 5 = 10737418240 => 32-bit integer overflow
+v = mul( 2147483648>>>0, 5>>>0 ); // 2^31 * 5 = 10737418240 => 32-bit integer overflow
 // returns 2147483648
 ```
 
@@ -58,7 +58,7 @@ v = umul( 2147483648>>>0, 5>>>0 ); // 2^31 * 5 = 10737418240 => 32-bit integer o
 
 ## Notes
 
--   The function emulates C-like multiplication of two unsigned 32-bit integers.
+-   The function performs C-like multiplication of two unsigned 32-bit integers, including wraparound semantics.
 
 </section>
 
@@ -73,7 +73,7 @@ v = umul( 2147483648>>>0, 5>>>0 ); // 2^31 * 5 = 10737418240 => 32-bit integer o
 ```javascript
 var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
 var UINT32_MAX = require( '@stdlib/constants/uint32/max' );
-var umul = require( '@stdlib/number/uint32/base/mul' );
+var mul = require( '@stdlib/number/uint32/base/mul' );
 
 var randi;
 var a;
@@ -86,7 +86,7 @@ randi = discreteUniform( 0, UINT32_MAX );
 for ( i = 0; i < 100; i++ ) {
     a = randi()>>>0;
     b = randi()>>>0;
-    y = umul( a, b );
+    y = mul( a, b );
     console.log( '%d x %d = %d', a, b, y );
 }
 ```

lib/node_modules/@stdlib/number/uint32/base/mul/benchmark/benchmark.js

@@ -24,7 +24,7 @@ var bench = require( '@stdlib/bench' );
 var minstd = require( '@stdlib/random/base/minstd' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pkg = require( './../package.json' ).name;
-var umul = require( './../lib' );
+var mul = require( './../lib' );
 
 
 // MAIN //
@@ -37,7 +37,7 @@ bench( pkg, function benchmark( b ) {
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
 		x = minstd();
-		y = umul( x>>>0, x>>>0 );
+		y = mul( x>>>0, x>>>0 );
 		if ( isnan( y ) ) {
 			b.fail( 'should not return NaN' );
 		}

lib/node_modules/@stdlib/number/uint32/base/mul/docs/repl.txt

@@ -1,13 +1,16 @@
 
-{{alias}}( a, b )
-    Performs C-like multiplication of two unsigned 32-bit integers.
+{{alias}}( x, y )
+    Multiples two unsigned 32-bit integers.
+
+    The function performs C-like multiplication of two unsigned 32-bit integers,
+    including wraparound semantics.
 
     Parameters
     ----------
-    a: integer
+    x: integer
         Unsigned 32-bit integer.
 
-    b: integer
+    y: integer
         Unsigned 32-bit integer.
 
     Returns

lib/node_modules/@stdlib/number/uint32/base/mul/docs/types/index.d.ts

@@ -19,19 +19,23 @@
 // TypeScript Version: 4.1
 
 /**
-* Performs C-like multiplication of two unsigned 32-bit integers.
+* Multiples two unsigned 32-bit integers.
 *
-* @param a - unsigned 32-bit integer
-* @param b - Unsigned 32-bit integer
-* @returns product
+* ## Notes
+*
+* -   The function performs C-like multiplication of two unsigned 32-bit integers, including wraparound semantics.
+*
+* @param x - first input value
+* @param y - second input value
+* @returns result
 *
 * @example
-* var v = umul( 10>>>0, 4>>>0 );
+* var v = mul( 10>>>0, 4>>>0 );
 * // returns 40
 */
-declare function umul( a: number, b: number ): number;
+declare function mul( x: number, y: number ): number;
 
 
 // EXPORTS //
 
-export = umul;
+export = mul;