docs: update descriptions

Planeshifter · Planeshifter · commit a9fb57ec4697 · 2025-11-09T13:59:59.000-06:00
---
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: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: passed
  - 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
---
diff --git a/lib/node_modules/@stdlib/blas/ext/to-sortedhp/lib/main.js b/lib/node_modules/@stdlib/blas/ext/to-sortedhp/lib/main.js
@@ -124,7 +124,7 @@ function toSortedhp( x ) {
 		}
 	}
 	xdt = getDType( x );
-	if ( hasOwnProp( options, 'dtype' ) ) {
+	if ( options && hasOwnProp( options, 'dtype' ) ) {
 		ydt = options.dtype;
 		if ( !isMostlySafeCast( xdt, ydt ) ) {
 			throw new TypeError( format( 'invalid argument. First argument cannot be safely cast to the output data type. Data types: [%s, %s].', resolveStr( xdt ), resolveStr( ydt ) ) );
diff --git a/lib/node_modules/@stdlib/math/base/special/acosh/README.md b/lib/node_modules/@stdlib/math/base/special/acosh/README.md
@@ -32,7 +32,7 @@ var acosh = require( '@stdlib/math/base/special/acosh' );
 
 #### acosh( x )
 
-Computes the [hyperbolic arccosine][hyperbolic-arccosine] of double-precision floating-point number.
+Computes the [hyperbolic arccosine][hyperbolic-arccosine] of a double-precision floating-point number.
 
 ```javascript
 var v = acosh( 1.0 );
@@ -106,7 +106,7 @@ logEachMap( 'acosh(%0.4f) = %0.4f', x, acosh );
 
 #### stdlib_base_acosh( x )
 
-Computes the [hyperbolic arccosine][hyperbolic-arccosine] of double-precision floating-point number.
+Computes the [hyperbolic arccosine][hyperbolic-arccosine] of a double-precision floating-point number.
 
 ```c
 double out = stdlib_base_acosh( 1.0 );
diff --git a/lib/node_modules/@stdlib/math/base/special/acosh/include/stdlib/math/base/special/acosh.h b/lib/node_modules/@stdlib/math/base/special/acosh/include/stdlib/math/base/special/acosh.h
@@ -27,7 +27,7 @@ extern "C" {
 #endif
 
 /**
-* Computes the hyperbolic arccosine of double-precision floating-point number.
+* Computes the hyperbolic arccosine of a double-precision floating-point number.
 */
 double stdlib_base_acosh( const double x );
 
diff --git a/lib/node_modules/@stdlib/math/base/special/acosh/package.json b/lib/node_modules/@stdlib/math/base/special/acosh/package.json
@@ -76,8 +76,8 @@
       "$schema": "math/base@v1.0",
       "base_alias": "acosh",
       "alias": "acosh",
-      "pkg_desc": "compute the hyperbolic arccosine of double-precision floating-point number",
-      "desc": "computes the hyperbolic arccosine of double-precision floating-point number",
+      "pkg_desc": "compute the hyperbolic arccosine of a double-precision floating-point number",
+      "desc": "computes the hyperbolic arccosine of a double-precision floating-point number",
       "short_desc": "hyperbolic arccosine",
       "parameters": [
         {
diff --git a/lib/node_modules/@stdlib/math/base/special/acosh/src/main.c b/lib/node_modules/@stdlib/math/base/special/acosh/src/main.c
@@ -41,7 +41,7 @@
 static const double HUGE = 1 << 28; // 2**28
 
 /**
-*  Computes the hyperbolic arccosine of double-precision floating-point number.
+*  Computes the hyperbolic arccosine of a double-precision floating-point number.
 *
 * ## Method
 *
diff --git a/lib/node_modules/@stdlib/math/base/special/acsch/include/stdlib/math/base/special/acsch.h b/lib/node_modules/@stdlib/math/base/special/acsch/include/stdlib/math/base/special/acsch.h
@@ -27,7 +27,7 @@ extern "C" {
 #endif
 
 /**
-* Computes the hyperbolic arccosecant of double-precision floating-point number.
+* Computes the hyperbolic arccosecant of a double-precision floating-point number.
 */
 double stdlib_base_acsch( const double x );
 
diff --git a/lib/node_modules/@stdlib/math/base/special/acsch/src/main.c b/lib/node_modules/@stdlib/math/base/special/acsch/src/main.c
@@ -20,7 +20,7 @@
 #include "stdlib/math/base/special/asinh.h"
 
 /**
-* Computes the hyperbolic arccosecant of double-precision floating-point number.
+* Computes the hyperbolic arccosecant of a double-precision floating-point number.
 *
 * @param x    input value
 * @return     output value
diff --git a/lib/node_modules/@stdlib/math/base/special/asech/include/stdlib/math/base/special/asech.h b/lib/node_modules/@stdlib/math/base/special/asech/include/stdlib/math/base/special/asech.h
@@ -27,7 +27,7 @@ extern "C" {
 #endif
 
 /**
-* Computes the hyperbolic arcsecant of double-precision floating-point number.
+* Computes the hyperbolic arcsecant of a double-precision floating-point number.
 */
 double stdlib_base_asech( const double x );
 
diff --git a/lib/node_modules/@stdlib/math/base/special/asinh/include/stdlib/math/base/special/asinh.h b/lib/node_modules/@stdlib/math/base/special/asinh/include/stdlib/math/base/special/asinh.h
@@ -27,7 +27,7 @@ extern "C" {
 #endif
 
 /**
-* Computes the hyperbolic arcsine of double-precision floating-point number.
+* Computes the hyperbolic arcsine of a double-precision floating-point number.
 */
 double stdlib_base_asinh( const double x );
 
diff --git a/lib/node_modules/@stdlib/math/base/special/asinh/src/main.c b/lib/node_modules/@stdlib/math/base/special/asinh/src/main.c
@@ -43,7 +43,7 @@ static const double NEAR_ZERO = 1.0 / (1 << 28); // 2**-28
 static const double HUGE = 1 << 28; // 2**28
 
 /**
-* Computes the hyperbolic arcsine of double-precision floating-point number.
+* Computes the hyperbolic arcsine of a double-precision floating-point number.
 *
 * ## Method
 *
diff --git a/lib/node_modules/@stdlib/math/base/special/fast/asinh/include/stdlib/math/base/special/fast/asinh.h b/lib/node_modules/@stdlib/math/base/special/fast/asinh/include/stdlib/math/base/special/fast/asinh.h
@@ -27,7 +27,7 @@ extern "C" {
 #endif
 
 /**
-* Computes the hyperbolic arcsine of double-precision floating-point number.
+* Computes the hyperbolic arcsine of a double-precision floating-point number.
 */
 double stdlib_base_fast_asinh( const double x );
 
diff --git a/lib/node_modules/@stdlib/math/base/special/sech/README.md b/lib/node_modules/@stdlib/math/base/special/sech/README.md
@@ -103,7 +103,7 @@ logEachMap( 'sech(%0.4f) = %0.4f', x, sech );
 
 #### stdlib_base_sech( x )
 
-Computes the [hyperbolic secant][hyperbolic-functions] of double-precision floating-point number.
+Computes the [hyperbolic secant][hyperbolic-functions] of a double-precision floating-point number.
 
 ```c
 double out = stdlib_base_sech( 2.0 );
diff --git a/lib/node_modules/@stdlib/math/special/data/unary.json b/lib/node_modules/@stdlib/math/special/data/unary.json
@@ -1392,8 +1392,8 @@
     "$schema": "math/base@v1.0",
     "base_alias": "acosh",
     "alias": "acosh",
-    "pkg_desc": "compute the hyperbolic arccosine of double-precision floating-point number",
-    "desc": "computes the hyperbolic arccosine of double-precision floating-point number",
+    "pkg_desc": "compute the hyperbolic arccosine of a double-precision floating-point number",
+    "desc": "computes the hyperbolic arccosine of a double-precision floating-point number",
     "short_desc": "hyperbolic arccosine",
     "parameters": [
       {

Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,7 @@ function toSortedhp( x ) {`
`124`	`124`	`}`
`125`	`125`	`}`
`126`	`126`	`xdt = getDType( x );`
`127`		`- if ( hasOwnProp( options, 'dtype' ) ) {`
	`127`	`+ if ( options && hasOwnProp( options, 'dtype' ) ) {`
`128`	`128`	`ydt = options.dtype;`
`129`	`129`	`if ( !isMostlySafeCast( xdt, ydt ) ) {`
`130`	`130`	`throw new TypeError( format( 'invalid argument. First argument cannot be safely cast to the output data type. Data types: [%s, %s].', resolveStr( xdt ), resolveStr( ydt ) ) );`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@`
`41`	`41`	`static const double HUGE = 1 << 28; // 2**28`
`42`	`42`
`43`	`43`	`/**`
`44`		`-* Computes the hyperbolic arccosine of double-precision floating-point number.`
	`44`	`+* Computes the hyperbolic arccosine of a double-precision floating-point number.`
`45`	`45`	`*`
`46`	`46`	`* ## Method`
`47`	`47`	`*`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`#include "stdlib/math/base/special/asinh.h"`
`21`	`21`
`22`	`22`	`/**`
`23`		`-* Computes the hyperbolic arccosecant of double-precision floating-point number.`
	`23`	`+* Computes the hyperbolic arccosecant of a double-precision floating-point number.`
`24`	`24`	`*`
`25`	`25`	`* @param x input value`
`26`	`26`	`* @return output value`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ static const double NEAR_ZERO = 1.0 / (1 << 28); // 2**-28`
`43`	`43`	`static const double HUGE = 1 << 28; // 2**28`
`44`	`44`
`45`	`45`	`/**`
`46`		`-* Computes the hyperbolic arcsine of double-precision floating-point number.`
	`46`	`+* Computes the hyperbolic arcsine of a double-precision floating-point number.`
`47`	`47`	`*`
`48`	`48`	`* ## Method`
`49`	`49`	`*`