Commit 512262b
committed
docs: fix TSDoc issues in several
Correct documentation-only issues in the TypeScript declaration files
flagged by an audit of the `@stdlib/math/iter` namespace:
- `sequences/nonpositive-even-integers`: the `iter` option `@throws`
said "nonpositive integer"; `iter` is an iteration count, so it must
be "nonnegative integer" (matching every sibling sequence package).
- `special/pow`: the summary called the operation the "exponential
function", but it computes `base^exponent`; reword to "power
function (i.e., `base` raised to the power `exponent`)".
- `special/ahaversin`: "versed sin" -> "versed sine" in the summary
and Notes.
- `sequences/integers`: the documented default `iter` value was off by
two (`18014398509481984` -> `18014398509481982`, i.e.
`FLOAT64_MAX_SAFE_INTEGER * 2`).
- `tools/map`: add the non-numeric/`NaN` handling Notes bullet that the
sibling `map2`/`map3` declarations include.
- `special/acoth`: spell out the infinity notation in the domain note
(`(-infinity,-1]`, `[1,+infinity)`) to match the sibling `acosh`.
This PR addresses only the TypeScript declaration files; the
corresponding README/REPL prose can be synced separately.
---
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/iter declarations1 parent 34f9bab commit 512262b
6 files changed
Lines changed: 8 additions & 6 deletions
File tree
- lib/node_modules/@stdlib/math/iter
- sequences
- integers/docs/types
- nonpositive-even-integers/docs/types
- special
- acoth/docs/types
- ahaversin/docs/types
- pow/docs/types
- tools/map/docs/types
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
43 | 43 | | |
44 | 44 | | |
45 | 45 | | |
46 | | - | |
| 46 | + | |
47 | 47 | | |
48 | 48 | | |
49 | 49 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
44 | 44 | | |
45 | 45 | | |
46 | 46 | | |
47 | | - | |
| 47 | + | |
48 | 48 | | |
49 | 49 | | |
50 | 50 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
33 | | - | |
| 33 | + | |
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
| |||
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 | | |
33 | | - | |
| 33 | + | |
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
29 | | - | |
| 29 | + | |
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
| |||
Lines changed: 2 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
52 | 52 | | |
53 | 53 | | |
54 | 54 | | |
| 55 | + | |
| 56 | + | |
55 | 57 | | |
56 | 58 | | |
57 | 59 | | |
| |||
0 commit comments