Skip to content

Commit 796b024

Browse files
committed
docs: fix TSDoc issues across many @stdlib/math/base/special declarations
Correct documentation-only issues in the TypeScript declaration files flagged by an audit of the `@stdlib/math/base/special` namespace. No emitted types change in a behavior-affecting way; the edits are limited to TSDoc prose, examples, parameter names/descriptions, and internal interface names. Highlights: - `kernel-betainc`: the 4th/5th parameters were named `invert`/ `normalized` with descriptions swapped relative to the implementation `kernelBetainc( x, a, b, regularized, upper )`; rename to `regularized`/`upper` and re-pair the descriptions, fix the garbled "regularized boolean beta function" -> "incomplete beta function", and fix the interface doc comment misspelling `kernalBetaInc`. - `gammainc`: split the muddled `regularized`/`upper` Notes into two clear bullets and fix a stale `s <= 0` -> `a <= 0` reference. - `cfloor`: summary now says "Rounds each component of..." like its siblings; `cpolarf`/`sincosd`: fix copy-pasted/lowercase interface names (`Cpolar` -> `Cpolarf`, `sincosd` -> `SinCosd`). - `minmax`/`minmaxn`/`minmaxf`/`sincospi`: `assign` `@example`s now call the `.assign` method instead of the bare function (so `v === out` is actually `true`); correct the `assign` summary/`@returns` for `sincospi`; split merged `@example` blocks. - `minabs`: drop the empty-set Notes paragraph (the function is binary); `minabsn`/`maxabsn`/`minmaxabsn`: correct the empty-args identity Notes (a minimum's bound is the greatest *lower* bound; the absolute maximum's empty result follows from the `-infinity` identity). - `covercos`/`coversin`/`havercos`: add the defining-formula Notes block their forward-trig siblings include. - Assorted prose fixes: `frexp`/`frexpf` "Inteface" typo, `cscd`/`absf`/ `acsch`/`asech`/`nonfibonacci`/`nonfibonaccif`/`negalucasf` summary/ Notes wording, `floorn` summary ("numeric value", matching `ceiln`/ `roundn`/`truncn`), `cotd`/`tand` trailing periods, `cround` unused requires, `powf` single-precision pi literal, `gammaincinv` argument-order notation, `lnf`/`round` `@returns`, `truncsd`/ `binomcoef`/`fast/hypot`/`fast/hypotf` `@param` descriptions, `gamma-lanczos-sum-expg-scaled` unbalanced parenthesis, `sind` example spacing, `fast/maxf` stray blank line, and a few missing `@example` tags and interface doc comments. This PR addresses only the TypeScript declaration files; the generated namespace aggregator will pick up these fixes on regeneration. --- 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_pkg_readmes status: na - task: lint_markdown_docs status: na - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - 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: 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: passed - task: lint_license_headers status: passed ---
1 parent 34f9bab commit 796b024

40 files changed

Lines changed: 80 additions & 66 deletions

File tree

lib/node_modules/@stdlib/math/base/special/absf/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
// TypeScript Version: 4.1
2020

2121
/**
22-
* Computes the absolute value of single-precision floating-point number `x`.
22+
* Computes the absolute value of a single-precision floating-point number `x`.
2323
*
2424
* @param x - input value
2525
* @returns absolute value

lib/node_modules/@stdlib/math/base/special/acsch/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
// TypeScript Version: 4.1
2020

2121
/**
22-
* Computes the hyperbolic arccosecant of a number.
22+
* Computes the hyperbolic arccosecant of a double-precision floating-point number.
2323
*
2424
* @param x - input value
2525
* @returns hyperbolic arccosecant

lib/node_modules/@stdlib/math/base/special/asech/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
// TypeScript Version: 4.1
2020

2121
/**
22-
* Computes the hyperbolic arcsecant of a number.
22+
* Computes the hyperbolic arcsecant of a double-precision floating-point number.
2323
*
2424
* @param x - input value
2525
* @returns hyperbolic arcsecant

lib/node_modules/@stdlib/math/base/special/binomcoef/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
/**
2222
* Computes the binomial coefficient of two integers.
2323
*
24-
* @param n - input value
24+
* @param n - first input value
2525
* @param k - second input value
2626
* @returns function value
2727
*

lib/node_modules/@stdlib/math/base/special/cfloor/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
import { Complex128 } from '@stdlib/types/complex';
2424

2525
/**
26-
* Rounds a double-precision complex floating-point number toward negative infinity.
26+
* Rounds each component of a double-precision complex floating-point number toward negative infinity.
2727
*
2828
* @param z - input value
2929
* @returns result

lib/node_modules/@stdlib/math/base/special/cotd/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
// TypeScript Version: 4.1
2020

2121
/**
22-
* Computes the cotangent of an angle measured in degrees
22+
* Computes the cotangent of an angle measured in degrees.
2323
*
2424
* @param x - input value (in degrees)
2525
* @returns cotangent

lib/node_modules/@stdlib/math/base/special/covercos/docs/types/index.d.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@
2121
/**
2222
* Computes the coversed cosine.
2323
*
24+
* ## Notes
25+
*
26+
* - The coversed cosine is defined as `1 + sin(x)`.
27+
*
2428
* @param x - input value (in radians)
2529
* @returns coversed cosine
2630
*

lib/node_modules/@stdlib/math/base/special/coversin/docs/types/index.d.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@
2121
/**
2222
* Computes the coversed sine.
2323
*
24+
* ## Notes
25+
*
26+
* - The coversed sine is defined as `1 - sin(x)`.
27+
*
2428
* @param x - input value (in radians)
2529
* @returns coversed sine
2630
*

lib/node_modules/@stdlib/math/base/special/cpolarf/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import { Collection } from '@stdlib/types/array';
2626
/**
2727
* Interface describing `cpolarf`.
2828
*/
29-
interface Cpolar {
29+
interface Cpolarf {
3030
/**
3131
* Computes the absolute value and the phase of a single-precision complex floating-point number.
3232
*
@@ -77,7 +77,7 @@ interface Cpolar {
7777
* var v = cpolarf( new Complex64( 5.0, 3.0 ) );
7878
* // returns [ ~5.83, ~0.5404 ]
7979
*/
80-
declare var cpolarf: Cpolar;
80+
declare var cpolarf: Cpolarf;
8181

8282

8383
// EXPORTS //

lib/node_modules/@stdlib/math/base/special/cround/docs/types/index.d.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,6 @@ import { Complex128 } from '@stdlib/types/complex';
3030
*
3131
* @example
3232
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
33-
* var real = require( '@stdlib/complex/float64/real' );
34-
* var imag = require( '@stdlib/complex/float64/imag' );
3533
*
3634
* var v = cround( new Complex128( -4.2, 5.5 ) );
3735
* // returns <Complex128>[ -4.0, 6.0 ]

0 commit comments

Comments
 (0)