docs: fix TSDoc issues in several math/iter declarations#12462
Merged
Conversation
Contributor
Coverage ReportNo coverage information available. |
7 tasks
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 and
the package's own `lib/validate.js`).
- `special/ahaversin`: "versed sin" -> "versed sine" in the summary
and Notes.
- `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. (Two further
`iter` findings -- `special/pow` "exponential function" -> "power
function" and the `sequences/integers` default value -- are package-wide
and handled in a separate PR.)
---
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
---
Planeshifter
force-pushed
the
philipp/docs-fix-iter-declarations
branch
from
512262b to
eece489
Compare
Planeshifter
changed the title
@stdlib/math/iter declarationsmath/iter declarations
kgryte
reviewed
Jun 3, 2026
Co-authored-by: Athan <kgryte@gmail.com> Signed-off-by: Athan <kgryte@gmail.com>
kgryte
approved these changes
Jun 3, 2026
kgryte
added
the
Documentation
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
3 participants
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/iternamespace, flagged by an audit:sequences/nonpositive-even-integers— theiteroption@throwssaid "nonpositive integer";iteris an iteration count, so it must be "nonnegative integer" (matching every sibling sequence package and the package's ownlib/validate.js).special/ahaversin— "versed sin" → "versed sine" in the summary and Notes.tools/map— added the non-numeric/NaNhandling Notes bullet that the siblingmap2/map3declarations include.special/acoth— spelled out the infinity notation in the domain note ((-infinity,-1],[1,+infinity)) to match the siblingacosh.This PR addresses only the TypeScript declaration files. Two further
iterfindings —special/pow("exponential function" → "power function") and thesequences/integersdefault value — are package-wide and handled in a separate PR (#12473).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