Commit ec5a8de
committed
docs: fix miscellaneous TSDoc issues in
Correct documentation-only issues flagged by an audit:
- `base/utils/float64-epsilon-difference`: add the `@throws must
provide a recognized scale function name` tag that the sibling
`relative-difference` documents. `epsilonDifference` accepts the same
`scale` argument and delegates to `reldiff`, which throws on an
unrecognized scale-name string.
- `special/abs`: remove an unused `@stdlib/ndarray/to-array` require
from an `@example`, and correct the malformed `// returns
<ndarray>[ ... ]` annotations to `// returns <ndarray>` (the
operations return ndarrays, not array literals).
This PR addresses only the TypeScript declaration files. The matching
namespace aggregators are generated and 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 declarations1 parent 34f9bab commit ec5a8de
2 files changed
Lines changed: 5 additions & 5 deletions
File tree
- lib/node_modules/@stdlib/math
- base/utils/float64-epsilon-difference/docs/types
- special/abs/docs/types
Lines changed: 1 addition & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
60 | 60 | | |
61 | 61 | | |
62 | 62 | | |
| 63 | + | |
63 | 64 | | |
64 | 65 | | |
65 | 66 | | |
| |||
Lines changed: 4 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
69 | 69 | | |
70 | 70 | | |
71 | 71 | | |
72 | | - | |
| 72 | + | |
73 | 73 | | |
74 | 74 | | |
75 | 75 | | |
| |||
87 | 87 | | |
88 | 88 | | |
89 | 89 | | |
90 | | - | |
| 90 | + | |
91 | 91 | | |
92 | 92 | | |
93 | 93 | | |
| |||
108 | 108 | | |
109 | 109 | | |
110 | 110 | | |
111 | | - | |
| 111 | + | |
112 | 112 | | |
113 | 113 | | |
114 | | - | |
115 | 114 | | |
116 | 115 | | |
117 | 116 | | |
118 | 117 | | |
119 | 118 | | |
120 | 119 | | |
121 | | - | |
| 120 | + | |
122 | 121 | | |
123 | 122 | | |
124 | 123 | | |
| |||
0 commit comments