Auto-generated commit

stdlib-bot · stdlib-bot · commit b574d74d2227 · 2024-09-17T14:04:14.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-09-16)
+## Unreleased (2024-09-17)
 
 <section class="packages">
 
@@ -216,6 +216,9 @@ A total of 5 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)_
+-   [`31fd427`](https://github.com/stdlib-js/stdlib/commit/31fd42744ec5d7073041f97c6f72350b8005c0fc) - **style:** remove unwanted empty lines _(by Philipp Burckhardt)_
 -   [`5279713`](https://github.com/stdlib-js/stdlib/commit/527971383e70a0e92dbca647dabfef27f294f149) - **feat:** add `isWebAssemblyMemory` to namespace _(by Athan Reines)_
 -   [`718ba36`](https://github.com/stdlib-js/stdlib/commit/718ba365fd18e0e35582433c22f6878a0e744675) - **feat:** add `assert/is-wasm-memory` _(by Athan Reines)_
 -   [`15e6c71`](https://github.com/stdlib-js/stdlib/commit/15e6c71cac991fadbb8f804a7811650daa0d5e87) - **feat:** add `assert/is-same-array-like-object` _(by yaswanth, Philipp Burckhardt)_
diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -2,6 +2,7 @@
 #
 # Contributors listed in alphabetical order.
 
+Aayush Khanna <96649223+aayush0325@users.noreply.github.com>
 Adarsh Palaskar <adarshpalaskar99@gmail.com>
 Aditya Sapra <adityaework@gmail.com>
 AgPriyanshu18 <113460573+AgPriyanshu18@users.noreply.github.com>
@@ -39,6 +40,7 @@ Joey Reed <joeyrreed@gmail.com>
 Jordan Gallivan <115050475+Jordan-Gallivan@users.noreply.github.com>
 Joris Labie <joris.labie1@gmail.com>
 Justin Dennison <justin1dennison@gmail.com>
+Kaif Mohd <mdkaifprofession@gmail.com>
 Karthik Prakash <116057817+skoriop@users.noreply.github.com>
 Khaldon <kahmd1444@gmail.com>
 Krishnendu Das <86651039+itskdhere@users.noreply.github.com>
diff --git a/is-boolean-array/docs/types/test.ts b/is-boolean-array/docs/types/test.ts
@@ -46,7 +46,6 @@ import isBooleanArray = require( './index' );
 	isBooleanArray.primitives( [ true ], 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an `objects` method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-boolean/docs/types/test.ts b/is-boolean/docs/types/test.ts
@@ -46,7 +46,6 @@ import isBoolean = require( './index' );
 	isBoolean.isPrimitive( true, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-circular/README.md b/is-circular/README.md
@@ -32,7 +32,7 @@ var isCircular = require( '@stdlib/assert/is-circular' );
 
 #### isCircular( value )
 
-Test if an object-like `value` contains a circular reference.
+Tests if an object-like `value` contains a circular reference.
 
 ```javascript
 var obj = {
diff --git a/is-composite/docs/types/test.ts b/is-composite/docs/types/test.ts
@@ -46,7 +46,6 @@ import isComposite = require( './index' );
 	isComposite.isPrimitive( 0.2, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-cube-number/docs/types/test.ts b/is-cube-number/docs/types/test.ts
@@ -46,7 +46,6 @@ import isCubeNumber = require( './index' );
 	isCubeNumber.isPrimitive( 0.2, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-empty-string/docs/types/test.ts b/is-empty-string/docs/types/test.ts
@@ -46,7 +46,6 @@ import isEmptyString = require( './index' );
 	isEmptyString.isPrimitive( 'abc', 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-even/docs/types/test.ts b/is-even/docs/types/test.ts
@@ -46,7 +46,6 @@ import isEven = require( './index' );
 	isEven.isPrimitive( 4, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-finite/docs/types/test.ts b/is-finite/docs/types/test.ts
@@ -46,7 +46,6 @@ import isFinite = require( './index' );
 	isFinite.isPrimitive( 4, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-infinite/docs/types/test.ts b/is-infinite/docs/types/test.ts
@@ -46,7 +46,6 @@ import isInfinite = require( './index' );
 	isInfinite.isPrimitive( 1 / 0, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-integer/docs/types/test.ts b/is-integer/docs/types/test.ts
@@ -46,7 +46,6 @@ import isInteger = require( './index' );
 	isInteger.isPrimitive( 2, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-nan/docs/types/test.ts b/is-nan/docs/types/test.ts
@@ -46,7 +46,6 @@ import isnan = require( './index' );
 	isnan.isPrimitive( NaN, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-negative-integer-array/docs/types/test.ts b/is-negative-integer-array/docs/types/test.ts
@@ -46,7 +46,6 @@ import isNegativeIntegerArray = require( './index' );
 	isNegativeIntegerArray.primitives( [ -2 ], 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an `objects` method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-negative-integer/docs/types/test.ts b/is-negative-integer/docs/types/test.ts
@@ -46,7 +46,6 @@ import isNegativeInteger = require( './index' );
 	isNegativeInteger.isPrimitive( -2, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-negative-number-array/docs/types/test.ts b/is-negative-number-array/docs/types/test.ts
@@ -46,7 +46,6 @@ import isNegativeNumberArray = require( './index' );
 	isNegativeNumberArray.primitives( [ -2 ], 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an `objects` method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-negative-number/docs/types/test.ts b/is-negative-number/docs/types/test.ts
@@ -46,7 +46,6 @@ import isNegativeNumber = require( './index' );
 	isNegativeNumber.isPrimitive( -2, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-negative-zero/docs/types/test.ts b/is-negative-zero/docs/types/test.ts
@@ -47,7 +47,6 @@ import isNegativeZero = require( './index' );
 	isNegativeZero.isPrimitive( -0, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-nonnegative-integer-array/docs/types/test.ts b/is-nonnegative-integer-array/docs/types/test.ts
@@ -46,7 +46,6 @@ import isNonNegativeIntegerArray = require( './index' );
 	isNonNegativeIntegerArray.primitives( [ 2 ], 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an `objects` method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-nonnegative-integer/docs/types/test.ts b/is-nonnegative-integer/docs/types/test.ts
@@ -46,7 +46,6 @@ import isNonNegativeInteger = require( './index' );
 	isNonNegativeInteger.isPrimitive( 2, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-nonnegative-number-array/docs/types/test.ts b/is-nonnegative-number-array/docs/types/test.ts
@@ -46,7 +46,6 @@ import isNonNegativeNumberArray = require( './index' );
 	isNonNegativeNumberArray.primitives( [ 2 ], 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an `objects` method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-nonnegative-number/docs/types/test.ts b/is-nonnegative-number/docs/types/test.ts
@@ -46,7 +46,6 @@ import isNonNegativeNumber = require( './index' );
 	isNonNegativeNumber.isPrimitive( 2, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-nonpositive-integer-array/docs/types/test.ts b/is-nonpositive-integer-array/docs/types/test.ts
@@ -46,7 +46,6 @@ import isNonPositiveIntegerArray = require( './index' );
 	isNonPositiveIntegerArray.primitives( [ -2 ], 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an `objects` method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-nonpositive-integer/docs/types/test.ts b/is-nonpositive-integer/docs/types/test.ts
@@ -46,7 +46,6 @@ import isNonPositiveInteger = require( './index' );
 	isNonPositiveInteger.isPrimitive( -2, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-nonpositive-number-array/docs/types/test.ts b/is-nonpositive-number-array/docs/types/test.ts
@@ -46,7 +46,6 @@ import isNonPositiveNumberArray = require( './index' );
 	isNonPositiveNumberArray.primitives( [ -2 ], 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an `objects` method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-nonpositive-number/docs/types/test.ts b/is-nonpositive-number/docs/types/test.ts
@@ -46,7 +46,6 @@ import isNonPositiveNumber = require( './index' );
 	isNonPositiveNumber.isPrimitive( -2, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-number/docs/types/test.ts b/is-number/docs/types/test.ts
@@ -46,7 +46,6 @@ import isNumber = require( './index' );
 	isNumber.isPrimitive( 2, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-odd/docs/types/test.ts b/is-odd/docs/types/test.ts
@@ -46,7 +46,6 @@ import isOdd = require( './index' );
 	isOdd.isPrimitive( 3, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-positive-finite/docs/types/test.ts b/is-positive-finite/docs/types/test.ts
@@ -46,7 +46,6 @@ import isPositiveFinite = require( './index' );
 	isPositiveFinite.isPrimitive( 2, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-positive-integer-array/docs/types/test.ts b/is-positive-integer-array/docs/types/test.ts
@@ -46,7 +46,6 @@ import isPositiveIntegerArray = require( './index' );
 	isPositiveIntegerArray.primitives( [ 2 ], 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an `objects` method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-positive-integer/docs/types/test.ts b/is-positive-integer/docs/types/test.ts
@@ -46,7 +46,6 @@ import isPositiveInteger = require( './index' );
 	isPositiveInteger.isPrimitive( 2, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-positive-number-array/docs/types/test.ts b/is-positive-number-array/docs/types/test.ts
@@ -46,7 +46,6 @@ import isPositiveNumberArray = require( './index' );
 	isPositiveNumberArray.primitives( [ 2 ], 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an `objects` method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-positive-number/docs/types/test.ts b/is-positive-number/docs/types/test.ts
@@ -46,7 +46,6 @@ import isPositiveNumber = require( './index' );
 	isPositiveNumber.isPrimitive( 2, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-positive-zero/docs/types/test.ts b/is-positive-zero/docs/types/test.ts
@@ -47,7 +47,6 @@ import isPositiveZero = require( './index' );
 	isPositiveZero.isPrimitive( 0, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-prime/docs/types/test.ts b/is-prime/docs/types/test.ts
@@ -46,7 +46,6 @@ import isPrime = require( './index' );
 	isPrime.isPrimitive( 0.2, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-probability-array/docs/types/test.ts b/is-probability-array/docs/types/test.ts
@@ -46,7 +46,6 @@ import isProbabilityArray = require( './index' );
 	isProbabilityArray.primitives( [ 0.2 ], 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an `objects` method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-probability/docs/types/test.ts b/is-probability/docs/types/test.ts
@@ -46,7 +46,6 @@ import isProbability = require( './index' );
 	isProbability.isPrimitive( 0.2, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-ragged-nested-array/package.json b/is-ragged-nested-array/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/assert/is-ragged-nested-array",
   "version": "0.0.0",
-  "description": "Test if a value is a ragged nested array",
+  "description": "Test if a value is a ragged nested array.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",
diff --git a/is-safe-integer/docs/types/test.ts b/is-safe-integer/docs/types/test.ts
@@ -46,7 +46,6 @@ import isSafeInteger = require( './index' );
 	isSafeInteger.isPrimitive( 2, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-same-array-like-object/README.md b/is-same-array-like-object/README.md
@@ -32,7 +32,7 @@ var isSameArrayLikeObject = require( '@stdlib/assert/is-same-array-like-object'
 
 #### isSameArrayLikeObject( v1, v2 )
 
-Test if two arguments are both [array-like objects][@stdlib/assert/is-array-like-object] and have the [same values][@stdlib/assert/is-same-value].
+Tests if two arguments are both [array-like objects][@stdlib/assert/is-array-like-object] and have the [same values][@stdlib/assert/is-same-value].
 
 ```javascript
 var x = [ 1.0, 2.0 ];
diff --git a/is-square-number/docs/types/test.ts b/is-square-number/docs/types/test.ts
@@ -46,7 +46,6 @@ import isSquareNumber = require( './index' );
 	isSquareNumber.isPrimitive( 0.2, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-square-triangular-number/docs/types/test.ts b/is-square-triangular-number/docs/types/test.ts
@@ -46,7 +46,6 @@ import isSquareTriangularNumber = require( './index' );
 	isSquareTriangularNumber.isPrimitive( 0.2, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-string-array/docs/types/test.ts b/is-string-array/docs/types/test.ts
@@ -46,7 +46,6 @@ import isStringArray = require( './index' );
 	isStringArray.primitives( [ 'abc' ], 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an `objects` method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-symbol-array/docs/types/test.ts b/is-symbol-array/docs/types/test.ts
@@ -46,7 +46,6 @@ import isSymbolArray = require( './index' );
 	isSymbolArray.primitives( [ Symbol( 'abc' ) ], 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an `objects` method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers
diff --git a/is-triangular-number/docs/types/test.ts b/is-triangular-number/docs/types/test.ts
@@ -46,7 +46,6 @@ import isTriangularNumber = require( './index' );
 	isTriangularNumber.isPrimitive( 0.2, 123 ); // $ExpectError
 }
 
-
 // Attached to main export is an isPrimitive method which returns a boolean...
 {
 	// eslint-disable-next-line no-new-wrappers

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,6 @@ import isBooleanArray = require( './index' );`
`46`	`46`	`isBooleanArray.primitives( [ true ], 123 ); // $ExpectError`
`47`	`47`	`}`
`48`	`48`
`49`		`-`
`50`	`49`	// Attached to main export is an `objects` method which returns a boolean...
`51`	`50`	`{`
`52`	`51`	`// eslint-disable-next-line no-new-wrappers`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,6 @@ import isBoolean = require( './index' );`
`46`	`46`	`isBoolean.isPrimitive( true, 123 ); // $ExpectError`
`47`	`47`	`}`
`48`	`48`
`49`		`-`
`50`	`49`	`// Attached to main export is an isPrimitive method which returns a boolean...`
`51`	`50`	`{`
`52`	`51`	`// eslint-disable-next-line no-new-wrappers`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,6 @@ import isComposite = require( './index' );`
`46`	`46`	`isComposite.isPrimitive( 0.2, 123 ); // $ExpectError`
`47`	`47`	`}`
`48`	`48`
`49`		`-`
`50`	`49`	`// Attached to main export is an isPrimitive method which returns a boolean...`
`51`	`50`	`{`
`52`	`51`	`// eslint-disable-next-line no-new-wrappers`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,6 @@ import isCubeNumber = require( './index' );`
`46`	`46`	`isCubeNumber.isPrimitive( 0.2, 123 ); // $ExpectError`
`47`	`47`	`}`
`48`	`48`
`49`		`-`
`50`	`49`	`// Attached to main export is an isPrimitive method which returns a boolean...`
`51`	`50`	`{`
`52`	`51`	`// eslint-disable-next-line no-new-wrappers`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,6 @@ import isEmptyString = require( './index' );`
`46`	`46`	`isEmptyString.isPrimitive( 'abc', 123 ); // $ExpectError`
`47`	`47`	`}`
`48`	`48`
`49`		`-`
`50`	`49`	`// Attached to main export is an isPrimitive method which returns a boolean...`
`51`	`50`	`{`
`52`	`51`	`// eslint-disable-next-line no-new-wrappers`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,6 @@ import isEven = require( './index' );`
`46`	`46`	`isEven.isPrimitive( 4, 123 ); // $ExpectError`
`47`	`47`	`}`
`48`	`48`
`49`		`-`
`50`	`49`	`// Attached to main export is an isPrimitive method which returns a boolean...`
`51`	`50`	`{`
`52`	`51`	`// eslint-disable-next-line no-new-wrappers`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,6 @@ import isFinite = require( './index' );`
`46`	`46`	`isFinite.isPrimitive( 4, 123 ); // $ExpectError`
`47`	`47`	`}`
`48`	`48`
`49`		`-`
`50`	`49`	`// Attached to main export is an isPrimitive method which returns a boolean...`
`51`	`50`	`{`
`52`	`51`	`// eslint-disable-next-line no-new-wrappers`