Commit 796b024
committed
docs: fix TSDoc issues across many
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
---@stdlib/math/base/special declarations1 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
- acsch/docs/types
- asech/docs/types
- binomcoef/docs/types
- cfloor/docs/types
- cotd/docs/types
- covercos/docs/types
- coversin/docs/types
- cpolarf/docs/types
- cround/docs/types
- cscd/docs/types
- fast
- hypotf/docs/types
- hypot/docs/types
- maxf/docs/types
- floorn/docs/types
- frexpf/docs/types
- frexp/docs/types
- gamma-lanczos-sum-expg-scaled/docs/types
- gammaincinv/docs/types
- gammainc/docs/types
- havercos/docs/types
- kernel-betainc/docs/types
- lnf/docs/types
- maxabsn/docs/types
- minabsn/docs/types
- minabs/docs/types
- minmaxabsn/docs/types
- minmaxf/docs/types
- minmaxn/docs/types
- minmax/docs/types
- negalucasf/docs/types
- nonfibonaccif/docs/types
- nonfibonacci/docs/types
- powf/docs/types
- round/docs/types
- sincosd/docs/types
- sincospi/docs/types
- sind/docs/types
- tand/docs/types
- truncsd/docs/types
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
22 | | - | |
| 22 | + | |
23 | 23 | | |
24 | 24 | | |
25 | 25 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
22 | | - | |
| 22 | + | |
23 | 23 | | |
24 | 24 | | |
25 | 25 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
22 | | - | |
| 22 | + | |
23 | 23 | | |
24 | 24 | | |
25 | 25 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
24 | | - | |
| 24 | + | |
25 | 25 | | |
26 | 26 | | |
27 | 27 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
23 | 23 | | |
24 | 24 | | |
25 | 25 | | |
26 | | - | |
| 26 | + | |
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
22 | | - | |
| 22 | + | |
23 | 23 | | |
24 | 24 | | |
25 | 25 | | |
| |||
Lines changed: 4 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
24 | 28 | | |
25 | 29 | | |
26 | 30 | | |
| |||
Lines changed: 4 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
24 | 28 | | |
25 | 29 | | |
26 | 30 | | |
| |||
Lines changed: 2 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
29 | | - | |
| 29 | + | |
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
| |||
77 | 77 | | |
78 | 78 | | |
79 | 79 | | |
80 | | - | |
| 80 | + | |
81 | 81 | | |
82 | 82 | | |
83 | 83 | | |
| |||
Lines changed: 0 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
33 | | - | |
34 | | - | |
35 | 33 | | |
36 | 34 | | |
37 | 35 | | |
| |||
0 commit comments