Merge remote-tracking branch 'upstream/develop' into add-kernel-log1pf

Author: stdlib-bot

.github/workflows/lint_random_files.yml

@@ -294,8 +294,12 @@ jobs:
 
       # Lint JavaScript files:
       - name: 'Lint JavaScript files'
+        id: lint-javascript
         if: ( github.event.inputs.javascript != 'false' ) && ( success() || failure() )
         run: |
+          # If any command in a pipeline fails, the entire pipeline should fail:
+          set -o pipefail
+
           # Determine root directory:
           root=$(git rev-parse --show-toplevel)
 
@@ -315,45 +319,81 @@ jobs:
             FIX=0
           fi
 
+          # Combined error file:
+          ERR_FILE="lint_javascript_errors.txt"
+          > "$ERR_FILE"  # Initialize a clean file
+
           # Lint JavaScript source files:
           files=$(echo "${{ steps.random-files.outputs.files }}" | tr ',' '\n' | grep '\.js$' | grep -v -e '/examples' -e '/test' -e '/benchmark' -e '^dist/' | tr '\n' ' ')
 
           # Build native addons if present:
           packages=$(echo "${files}" | tr ' ' '\n' | sed 's/^lib\/node_modules\///g' | sed 's/\/lib\/.*//g' | sort | uniq)
           for pkg in ${packages}; do
-              if [ -f "lib/node_modules/${pkg}/binding.gyp" ]; then
-                  NODE_ADDONS_PATTERN="${pkg}" make install-node-addons
-              fi
+            if [ -f "lib/node_modules/${pkg}/binding.gyp" ]; then
+                NODE_ADDONS_PATTERN="${pkg}" make install-node-addons
+            fi
           done
 
           if [[ -n "${files}" ]]; then
-            make lint-javascript-files FIX="${FIX}" FAST_FAIL=0 FILES="${files}"
+            make lint-javascript-files FIX="${FIX}" FAST_FAIL=0 FILES="${files}" 2>&1 | tee -a "$ERR_FILE"
           fi
 
           # Lint JavaScript command-line interfaces...
           file=$(echo "${{ steps.random-files.outputs.files }}" | tr ',' '\n' | grep '\.js$' | grep -E '/bin/cli$' | tr '\n' ' ')
           if [[ -n "${file}" ]]; then
-            make lint-javascript-files FIX="${FIX}" FAST_FAIL=0 FILES="${file}"
+            make lint-javascript-files FIX="${FIX}" FAST_FAIL=0 FILES="${file}" 2>&1 | tee -a "$ERR_FILE"
           fi
 
           # Lint JavaScript example files:
           files=$(echo "${{ steps.random-files.outputs.files }}" | tr ',' '\n' | grep '/examples/.*\.js$' | tr '\n' ' ')
           if [[ -n "${files}" ]]; then
-            make lint-javascript-files FIX="${FIX}" FAST_FAIL=0 FILES="${files}" ESLINT_CONF="${eslint_examples_conf}"
+            make lint-javascript-files FIX="${FIX}" FAST_FAIL=0 FILES="${files}" ESLINT_CONF="${eslint_examples_conf}" 2>&1 | tee -a "$ERR_FILE"
           fi
 
           # Lint JavaScript test files:
           files=$(echo "${{ steps.random-files.outputs.files }}" | tr ',' '\n' | grep '/test/.*\.js$' | tr '\n' ' ')
           if [[ -n "${files}" ]]; then
-            make lint-javascript-files FIX="${FIX}" FAST_FAIL=0 FILES="${files}" ESLINT_CONF="${eslint_tests_conf}"
+            make lint-javascript-files FIX="${FIX}" FAST_FAIL=0 FILES="${files}" ESLINT_CONF="${eslint_tests_conf}" 2>&1 | tee -a "$ERR_FILE"
           fi
 
           # Lint JavaScript benchmark files:
           files=$(echo "${{ steps.random-files.outputs.files }}" | tr ',' '\n' | grep '/benchmark/.*\.js$' | tr '\n' ' ')
           if [[ -n "${files}" ]]; then
-            make lint-javascript-files FIX="${FIX}" FAST_FAIL=0 FILES="${files}" ESLINT_CONF="${eslint_benchmarks_conf}"
+            make lint-javascript-files FIX="${FIX}" FAST_FAIL=0 FILES="${files}" ESLINT_CONF="${eslint_benchmarks_conf}" 2>&1 | tee -a "$ERR_FILE"
           fi
 
+      # Create sub-issue for JavaScript lint failures:
+      - name: 'Create sub-issue for JavaScript lint failures'
+        if: failure() && contains(steps.lint-javascript.outcome, 'failure')
+        env:
+          GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
+        run: |
+          BODY_FILE="$GITHUB_WORKSPACE/lint_issue_body.md"
+          cat << EOF > "$BODY_FILE"
+          ## JavaScript Linting Failures
+
+          Linting failures were detected in the automated JavaScript lint workflow run.
+
+          ### Workflow Details
+
+          - Run: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
+          - Type: JavaScript Linting
+          - Date: $(date -u +"%Y-%m-%d %H:%M:%S UTC")
+
+          ### Error Details
+          \`\`\`
+          $(cat lint_javascript_errors.txt)
+          \`\`\`
+          EOF
+
+          . "$GITHUB_WORKSPACE/.github/workflows/scripts/create_sub_issue" \
+            'Fix JavaScript lint errors' \
+            "$BODY_FILE" \
+            "5377" \
+            "Good First Issue"
+
+          rm "$BODY_FILE"
+
       # Lint Python files:
       - name: 'Lint Python files'
         if: ( github.event.inputs.python != 'false' ) && ( success() || failure() )

.mailmap

@@ -123,6 +123,9 @@ Naresh Jagadeesan <[email protected]> <[email protected].
 
 Naveen Kumar <[email protected]> naveen
 
+Neeraj Pathak <[email protected]> <[email protected]>
+Neeraj Pathak <[email protected]> Neerajpathak07
+
 Nishant Shinde <[email protected]> nishant-s7
 
 Nithin Katta <[email protected]> KATTA NAGA NITHIN

CONTRIBUTORS

@@ -135,6 +135,7 @@ Yaswanth Kosuru <[email protected]>
 Yernar Yergaziyev <[email protected]>
 Yuvi Mittal <[email protected]>
 ekambains <[email protected]>
+fadiothman22 <[email protected]>
 olenkabilonizhka <[email protected]>
 pranav-1720 <[email protected]>
 rainn <[email protected]>

docs/contributing/moving_packages.md

@@ -177,6 +177,8 @@ Ref: https://github.com/stdlib-js/stdlib/issues/4797
 
 ### 6. Remove the export of the original package from its parent namespace
 
+#### a. Namespace exports
+
 Next, open the `lib/index.js` file found in the parent namespace of the original package (e.g., `lib/node_modules/@stdlib/stats/base/lib/index.js`).
 
 If that file includes an exported symbol from the original package, remove it. For example,
@@ -193,6 +195,47 @@ If that file includes an exported symbol from the original package, remove it. F
 - setReadOnly( ns, 'dmax', require( '@stdlib/stats/base/dmax' ) );
 ```
 
+#### b. Namespace TypeScript declarations
+
+Next, open the `docs/types/index.d.ts` file found in the parent namespace of the original package (e.g., `lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts`).
+
+If that file includes an exported symbol from the original package, remove it. For example,
+
+```diff
+- import dmax = require( '@stdlib/stats/base/dmax' );
+```
+
+and
+
+```diff
+-
+-    /**
+-    * Computes the maximum value of a double-precision floating-point strided array.
+-    *
+-    * @param N - number of indexed elements
+-    * @param x - input array
+-    * @param strideX - stride length
+-    * @returns maximum value
+-    *
+-    * @example
+-    * var Float64Array = require( '@stdlib/array/float64' );
+-    *
+-    * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
+-    *
+-    * var v = ns.dmax( x.length, x, 1 );
+-    * // returns 2.0
+-    *
+-    * @example
+-    * var Float64Array = require( '@stdlib/array/float64' );
+-    *
+-    * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
+-    *
+-    * var v = ns.dmax.ndarray( x.length, x, 1, 0 );
+-    * // returns 2.0
+-    */
+-    dmax: typeof dmax;
+```
+
 ### 7. Commit the changes to the parent namespace
 
 If you removed an exported symbol from the parent namespace, commit those changes, making note that this is a breaking change.

lib/node_modules/@stdlib/blas/base/docs/types/index.d.ts

@@ -2400,39 +2400,19 @@ interface Namespace {
 	*
 	* @example
 	* var Complex128Array = require( '@stdlib/array/complex128' );
-	* var real = require( '@stdlib/complex/float64/real' );
-	* var imag = require( '@stdlib/complex/float64/imag' );
 	*
 	* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 	*
 	* ns.zdscal( 3, 2.0, zx, 1 );
-	*
-	* var z = zx.get( 1 );
-	* // returns <Complex128>
-	*
-	* var re = real( z );
-	* // returns 6.0
-	*
-	* var im = imag( z );
-	* // returns 8.0
+	* // zx => <Complex128Array>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
 	*
 	* @example
 	* var Complex128Array = require( '@stdlib/array/complex128' );
-	* var real = require( '@stdlib/complex/float64/real' );
-	* var imag = require( '@stdlib/complex/float64/imag' );
 	*
 	* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 	*
 	* ns.zdscal.ndarray( 2, 2.0, zx, 1, 1 );
-	*
-	* var z = zx.get( 1 );
-	* // returns <Complex128>
-	*
-	* var re = real( z );
-	* // returns 10.0
-	*
-	* var im = imag( z );
-	* // returns 12.0
+	* // zx => <Complex128Array>[ 1.0, 2.0, 6.0, 8.0, 10.0, 12.0 ]
 	*/
 	zdscal: typeof zdscal;
 

lib/node_modules/@stdlib/blas/base/wasm/ccopy/README.md

@@ -36,24 +36,14 @@ Copies values from `x` into `y`.
 
 ```javascript
 var Complex64Array = require( '@stdlib/array/complex64' );
-var realf = require( '@stdlib/complex/float32/real' );
-var imagf = require( '@stdlib/complex/float32/imag' );
 
 // Define strided arrays...
 var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
 
 // Perform operation:
 ccopy.main( x.length, x, 1, y, 1 );
-
-var v = y.get( 0 );
-// returns <Complex64>
-
-var re = realf( v );
-// returns 1.0
-
-var im = imagf( v );
-// returns 2.0
+// y => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 ```
 
 The function has the following parameters:
@@ -68,22 +58,12 @@ The `N` and stride parameters determine how values from `x` are copied into `y`.
 
 ```javascript
 var Complex64Array = require( '@stdlib/array/complex64' );
-var realf = require( '@stdlib/complex/float32/real' );
-var imagf = require( '@stdlib/complex/float32/imag' );
 
 var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
 var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
 
 ccopy.main( 2, x, -2, y, 1 );
-
-var v = y.get( 0 );
-// returns <Complex64>
-
-var re = realf( v );
-// returns 5.0
-
-var im = imagf( v );
-// returns 6.0
+// y => <Complex64Array>[ 5.0, 6.0, 1.0, 2.0, 0.0, 0.0, 0.0, 0.0 ]
 ```
 
 Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
@@ -92,8 +72,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
 
 ```javascript
 var Complex64Array = require( '@stdlib/array/complex64' );
-var realf = require( '@stdlib/complex/float32/real' );
-var imagf = require( '@stdlib/complex/float32/imag' );
 
 // Initial arrays...
 var x0 = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
@@ -105,15 +83,7 @@ var y1 = new Complex64Array( y0.buffer, y0.BYTES_PER_ELEMENT*2 ); // start at 3r
 
 // Copy every other value from `x1` into `y1` in reverse order...
 ccopy.main( 2, x1, -2, y1, 1 );
-
-var z = y0.get( 2 );
-// returns <Complex64>
-
-var re = realf( z );
-// returns 7.0
-
-var im = imagf( z );
-// returns 8.0
+// y0 => <Complex64Array>[ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ]
 ```
 
 #### ccopy.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )
@@ -122,22 +92,12 @@ Copies values from `x` into `y` using alternative indexing semantics.
 
 ```javascript
 var Complex64Array = require( '@stdlib/array/complex64' );
-var realf = require( '@stdlib/complex/float32/real' );
-var imagf = require( '@stdlib/complex/float32/imag' );
 
 var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
 
 ccopy.ndarray( x.length, x, 1, 0, y, 1, 0 );
-
-var v = y.get( 0 );
-// returns <Complex64>
-
-var re = realf( v );
-// returns 1.0
-
-var im = imagf( v );
-// returns 2.0
+// y => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 ```
 
 The function has the following additional parameters:
@@ -149,22 +109,12 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
 
 ```javascript
 var Complex64Array = require( '@stdlib/array/complex64' );
-var realf = require( '@stdlib/complex/float32/real' );
-var imagf = require( '@stdlib/complex/float32/imag' );
 
 var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
 var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
 
 ccopy.ndarray( 2, x, 2, 1, y, -1, y.length-1 );
-
-var z = y.get( y.length-1 );
-// returns <Complex64>
-
-var re = realf( z );
-// returns 3.0
-
-var im = imagf( z );
-// returns 4.0
+// y => <Complex64Array>[ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ]
 ```
 
 * * *