docs: fix TSDoc issues in several @stdlib/math/base/tools declarations#12464
Draft
Planeshifter wants to merge 1 commit into
Draft
docs: fix TSDoc issues in several @stdlib/math/base/tools declarations#12464Planeshifter wants to merge 1 commit into
@stdlib/math/base/tools declarations#12464Planeshifter wants to merge 1 commit into
Conversation
Correct documentation-only issues flagged by an audit of the
`@stdlib/math/base/tools` namespace:
- `chebyshev-series` / `chebyshev-seriesf`: remove the misleading inline
`// 1*T_0(1/2) + 0.5*T_1(1/2)` example comments, which evaluate to
1.25 and contradict the correct `// returns 0.75` annotations (the
coefficients are stored in descending-degree order with constant-term
half-weighting). Also drop the result-style comment misplaced on the
`factory(...)` construction line, which returns an evaluator function.
- `evalrational` / `evalrationalf`: correct off-by-one polynomial-degree
labels in the examples (a degree-3 polynomial was labeled "degree 4"
and a degree-1 polynomial "degree 2").
- `hermitepoly` / `normhermitepoly` / `normhermitepolyf`: add the
"nonnegative" qualifier to the `factory` method's `@param n` so it
matches the call-signature `@param n` in the same file.
This PR addresses only the TypeScript declaration files.
---
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
---
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request corrects documentation-only issues in TypeScript declaration files across the
@stdlib/math/base/toolsnamespace, flagged by an audit:chebyshev-series/chebyshev-seriesf— remove the misleading inline// 1*T_0(1/2) + 0.5*T_1(1/2)example comments, which evaluate to 1.25 and contradict the correct// returns 0.75annotations (the coefficients are stored in descending-degree order with constant-term half-weighting). Also drop the result-style comment misplaced on thefactory(...)construction line, which returns an evaluator function rather than a value.evalrational/evalrationalf— correct off-by-one polynomial-degree labels in the examples (a degree-3 polynomial was labeled "degree 4"; a degree-1 polynomial "degree 2").hermitepoly/normhermitepoly/normhermitepolyf— add the "nonnegative" qualifier to thefactorymethod's@param n, matching the call-signature@param nin the same file.This PR addresses only the TypeScript declaration files. (The audit also noted some optional cross-package wording/alias-naming polish in this namespace; those purely-cosmetic items are intentionally left out.)
Related Issues
No.
Questions
No.
Other
Found via a TypeScript-declaration audit of the
@stdlib/mathnamespace.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
These issues were identified by an automated TypeScript-declaration audit run with Claude Code, and the fixes were prepared by Claude Code under my review.
@stdlib-js/reviewers