Auto-generated commit

stdlib-js · Sep 17, 2024 · fb6e825 · fb6e825
1 parent 1070bf4
commit fb6e825
Show file tree

Hide file tree

Showing 29 changed files with 31 additions and 29 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -426,6 +426,8 @@ A total of 6 people contributed to this release. Thank you to the following cont
 
 <details>
 
+-   [`f387603`](https://github.com/stdlib-js/stdlib/commit/f387603e739f88a38af3263ce6ff675ad903ee8c) - **docs:** consistently use declarative instead of imperative sentences outside of intros _(by Philipp Burckhardt)_
+-   [`ed44fee`](https://github.com/stdlib-js/stdlib/commit/ed44feecb9eaa5e0849d1a533e5415624d0aa338) - **style:** use imperative in package.json description and end with period _(by Philipp Burckhardt)_
 -   [`08f39b4`](https://github.com/stdlib-js/stdlib/commit/08f39b45439d043323ec402647f6b3ea8a5a4a56) - **feat:** add C `ndarray` implementation for `blas/base/scopy` [(#2913)](https://github.com/stdlib-js/stdlib/pull/2913) _(by Aman Bhansali, Athan Reines)_
 -   [`40502bb`](https://github.com/stdlib-js/stdlib/commit/40502bb62ccef0eecf1132430422a35ae9e5dd3a) - **feat:** add C `ndarray` implementation for `blas/base/dcopy` [(#2906)](https://github.com/stdlib-js/stdlib/pull/2906) _(by Aman Bhansali, Athan Reines)_
 -   [`7e11338`](https://github.com/stdlib-js/stdlib/commit/7e11338ae6642c1389e51557262710bd6ebe44aa) - **feat:** add `blas/ext/base/zfill` [(#2907)](https://github.com/stdlib-js/stdlib/pull/2907) _(by Muhammad Haris, Athan Reines)_

diff --git a/base/cswap/package.json b/base/cswap/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/blas/base/cswap",
   "version": "0.0.0",
-  "description": "Interchanges two complex single-precision floating-point vectors.",
+  "description": "Interchange two complex single-precision floating-point vectors.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

diff --git a/base/dger/package.json b/base/dger/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/blas/base/dger",
   "version": "0.0.0",
-  "description": "Performs the rank 1 operation A = alpha⋅x⋅y^T + A.",
+  "description": "Perform the rank 1 operation A = alpha⋅x⋅y^T + A.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

diff --git a/base/diagonal-type-str2enum/README.md b/base/diagonal-type-str2enum/README.md
@@ -42,7 +42,7 @@ var str2enum = require( '@stdlib/blas/base/diagonal-type-str2enum' );
 
 #### str2enum( diagonal )
 
-Return the enumeration constant associated with a BLAS diagonal-type.
+Returns the enumeration constant associated with a BLAS diagonal-type.
 
 ```javascript
 var v = str2enum( 'unit' );

diff --git a/base/layout-str2enum/README.md b/base/layout-str2enum/README.md
@@ -42,7 +42,7 @@ var str2enum = require( '@stdlib/blas/base/layout-str2enum' );
 
 #### str2enum( layout )
 
-Return the enumeration constant associated with a BLAS memory layout string.
+Returns the enumeration constant associated with a BLAS memory layout string.
 
 ```javascript
 var v = str2enum( 'row-major' );

diff --git a/base/matrix-triangle-str2enum/README.md b/base/matrix-triangle-str2enum/README.md
@@ -42,7 +42,7 @@ var str2enum = require( '@stdlib/blas/base/matrix-triangle-str2enum' );
 
 #### str2enum( operation )
 
-Return the enumeration constant associated with a BLAS matrix triangle.
+Returns the enumeration constant associated with a BLAS matrix triangle.
 
 ```javascript
 var v = str2enum( 'upper' );

diff --git a/base/operation-side-str2enum/README.md b/base/operation-side-str2enum/README.md
@@ -42,7 +42,7 @@ var str2enum = require( '@stdlib/blas/base/operation-side-str2enum' );
 
 #### str2enum( operation )
 
-Return the enumeration constant associated with a BLAS operation side.
+Returns the enumeration constant associated with a BLAS operation side.
 
 ```javascript
 var v = str2enum( 'left' );

diff --git a/base/transpose-operation-str2enum/README.md b/base/transpose-operation-str2enum/README.md
@@ -42,7 +42,7 @@ var str2enum = require( '@stdlib/blas/base/transpose-operation-str2enum' );
 
 #### str2enum( operation )
 
-Return the enumeration constant associated with a BLAS transpose operation.
+Returns the enumeration constant associated with a BLAS transpose operation.
 
 ```javascript
 var v = str2enum( 'transpose' );

diff --git a/base/zswap/README.md b/base/zswap/README.md
@@ -40,7 +40,7 @@ var zswap = require( '@stdlib/blas/base/zswap' );
 
 #### zswap( N, x, strideX, y, strideY )
 
-Interchange two complex double-precision floating-point vectors.
+Interchanges two complex double-precision floating-point vectors.
 
 ```javascript
 var Complex128Array = require( '@stdlib/array/complex128' );
@@ -151,7 +151,7 @@ im = imag( z );
 
 #### zswap.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )
 
-Interchange two complex double-precision floating-point vectors using alternative indexing semantics.
+Interchanges two complex double-precision floating-point vectors using alternative indexing semantics.
 
 ```javascript
 var Complex128Array = require( '@stdlib/array/complex128' );

diff --git a/base/zswap/package.json b/base/zswap/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/blas/base/zswap",
   "version": "0.0.0",
-  "description": "Interchanges two complex double-precision floating-point vectors.",
+  "description": "Interchange two complex double-precision floating-point vectors.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

diff --git a/ext/base/dapxsum/package.json b/ext/base/dapxsum/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/blas/ext/base/dapxsum",
   "version": "0.0.0",
-  "description": "Adds a constant to each double-precision floating-point strided array element and computes the sum.",
+  "description": "Add a constant to each double-precision floating-point strided array element and computes the sum.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

diff --git a/ext/base/dapxsumkbn/package.json b/ext/base/dapxsumkbn/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/blas/ext/base/dapxsumkbn",
   "version": "0.0.0",
-  "description": "Adds a constant to each double-precision floating-point strided array element and computes the sum using an improved Kahan–Babuška algorithm.",
+  "description": "Add a constant to each double-precision floating-point strided array element and computes the sum using an improved Kahan–Babuška algorithm.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

diff --git a/ext/base/dapxsumkbn2/package.json b/ext/base/dapxsumkbn2/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/blas/ext/base/dapxsumkbn2",
   "version": "0.0.0",
-  "description": "Adds a constant to each double-precision floating-point strided array element and computes the sum using a second-order iterative Kahan–Babuška algorithm.",
+  "description": "Add a constant to each double-precision floating-point strided array element and computes the sum using a second-order iterative Kahan–Babuška algorithm.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

diff --git a/ext/base/dapxsumors/package.json b/ext/base/dapxsumors/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/blas/ext/base/dapxsumors",
   "version": "0.0.0",
-  "description": "Adds a constant to each double-precision floating-point strided array element and computes the sum using ordinary recursive summation.",
+  "description": "Add a constant to each double-precision floating-point strided array element and computes the sum using ordinary recursive summation.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

diff --git a/ext/base/dapxsumpw/package.json b/ext/base/dapxsumpw/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/blas/ext/base/dapxsumpw",
   "version": "0.0.0",
-  "description": "Adds a constant to each double-precision floating-point strided array element and computes the sum using pairwise summation.",
+  "description": "Add a constant to each double-precision floating-point strided array element and computes the sum using pairwise summation.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

diff --git a/ext/base/dsapxsum/package.json b/ext/base/dsapxsum/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/blas/ext/base/dsapxsum",
   "version": "0.0.0",
-  "description": "Adds a constant to each single-precision floating-point strided array element and computes the sum using extended accumulation and returning an extended precision result.",
+  "description": "Add a constant to each single-precision floating-point strided array element and computes the sum using extended accumulation and returning an extended precision result.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

diff --git a/ext/base/dsapxsumpw/package.json b/ext/base/dsapxsumpw/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/blas/ext/base/dsapxsumpw",
   "version": "0.0.0",
-  "description": "Adds a constant to each single-precision floating-point strided array element and computes the sum using pairwise summation with extended accumulation and returning an extended precision result.",
+  "description": "Add a constant to each single-precision floating-point strided array element and computes the sum using pairwise summation with extended accumulation and returning an extended precision result.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

diff --git a/ext/base/gapxsum/package.json b/ext/base/gapxsum/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/blas/ext/base/gapxsum",
   "version": "0.0.0",
-  "description": "Adds a constant to each strided array element and computes the sum.",
+  "description": "Add a constant to each strided array element and computes the sum.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

diff --git a/ext/base/gapxsumkbn/package.json b/ext/base/gapxsumkbn/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/blas/ext/base/gapxsumkbn",
   "version": "0.0.0",
-  "description": "Adds a constant to each strided array element and computes the sum using an improved Kahan–Babuška algorithm.",
+  "description": "Add a constant to each strided array element and computes the sum using an improved Kahan–Babuška algorithm.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

diff --git a/ext/base/gapxsumkbn2/package.json b/ext/base/gapxsumkbn2/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/blas/ext/base/gapxsumkbn2",
   "version": "0.0.0",
-  "description": "Adds a constant to each strided array element and computes the sum using a second-order iterative Kahan–Babuška algorithm.",
+  "description": "Add a constant to each strided array element and computes the sum using a second-order iterative Kahan–Babuška algorithm.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

diff --git a/ext/base/gapxsumors/package.json b/ext/base/gapxsumors/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/blas/ext/base/gapxsumors",
   "version": "0.0.0",
-  "description": "Adds a constant to each strided array element and computes the sum using ordinary recursive summation.",
+  "description": "Add a constant to each strided array element and computes the sum using ordinary recursive summation.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

diff --git a/ext/base/gapxsumpw/package.json b/ext/base/gapxsumpw/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/blas/ext/base/gapxsumpw",
   "version": "0.0.0",
-  "description": "Adds a constant to each strided array element and computes the sum using pairwise summation.",
+  "description": "Add a constant to each strided array element and computes the sum using pairwise summation.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

diff --git a/ext/base/sapxsum/package.json b/ext/base/sapxsum/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/blas/ext/base/sapxsum",
   "version": "0.0.0",
-  "description": "Adds a constant to each single-precision floating-point strided array element and computes the sum.",
+  "description": "Add a constant to each single-precision floating-point strided array element and computes the sum.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

diff --git a/ext/base/sapxsumkbn/package.json b/ext/base/sapxsumkbn/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/blas/ext/base/sapxsumkbn",
   "version": "0.0.0",
-  "description": "Adds a constant to each single-precision floating-point strided array element and computes the sum using an improved Kahan–Babuška algorithm.",
+  "description": "Add a constant to each single-precision floating-point strided array element and computes the sum using an improved Kahan–Babuška algorithm.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

diff --git a/ext/base/sapxsumkbn2/package.json b/ext/base/sapxsumkbn2/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/blas/ext/base/sapxsumkbn2",
   "version": "0.0.0",
-  "description": "Adds a constant to each single-precision floating-point strided array element and computes the sum using a second-order iterative Kahan–Babuška algorithm.",
+  "description": "Add a constant to each single-precision floating-point strided array element and computes the sum using a second-order iterative Kahan–Babuška algorithm.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

diff --git a/ext/base/sapxsumors/package.json b/ext/base/sapxsumors/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/blas/ext/base/sapxsumors",
   "version": "0.0.0",
-  "description": "Adds a constant to each single-precision floating-point strided array element and computes the sum using ordinary recursive summation.",
+  "description": "Add a constant to each single-precision floating-point strided array element and computes the sum using ordinary recursive summation.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

diff --git a/ext/base/sapxsumpw/package.json b/ext/base/sapxsumpw/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/blas/ext/base/sapxsumpw",
   "version": "0.0.0",
-  "description": "Adds a constant to each single-precision floating-point strided array element and computes the sum using pairwise summation.",
+  "description": "Add a constant to each single-precision floating-point strided array element and computes the sum using pairwise summation.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

diff --git a/ext/base/sdsapxsum/package.json b/ext/base/sdsapxsum/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/blas/ext/base/sdsapxsum",
   "version": "0.0.0",
-  "description": "Adds a constant to each single-precision floating-point strided array element and computes the sum using extended accumulation.",
+  "description": "Add a constant to each single-precision floating-point strided array element and computes the sum using extended accumulation.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

diff --git a/ext/base/sdsapxsumpw/package.json b/ext/base/sdsapxsumpw/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/blas/ext/base/sdsapxsumpw",
   "version": "0.0.0",
-  "description": "Adds a constant to each single-precision floating-point strided array element and computes the sum using pairwise summation with extended accumulation.",
+  "description": "Add a constant to each single-precision floating-point strided array element and computes the sum using pairwise summation with extended accumulation.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",