docs: fix package-wide doc errors in two math/iter packages#12473
Draft
Planeshifter wants to merge 1 commit into
Draft
docs: fix package-wide doc errors in two math/iter packages#12473Planeshifter wants to merge 1 commit into
math/iter packages#12473Planeshifter wants to merge 1 commit into
Conversation
Two findings were not specific to the TypeScript declarations but
appear consistently across each package's documentation surfaces:
- `special/pow`: the summary called the operation the "exponential
function", but the iterator evaluates `base^exponent` (the power
function). Reword to "power function (i.e., `base` raised to the
power `exponent`)" in the declaration, README, REPL help, `lib`
JSDoc, and `package.json` description. The auto-generated "See Also"
entries are left untouched.
- `sequences/integers`: the documented default for the `iter` option
was `18014398509481984`, two more than the actual default
`FLOAT64_MAX_SAFE_INTEGER * 2 = 18014398509481982`. Correct it in the
declaration, README, REPL help, and `lib/main.js` JSDoc.
Split out from the `@stdlib/math/iter` declarations PR so the fixes can
be applied consistently across all documentation surfaces.
---
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: passed
- task: lint_markdown_docs
status: na
- task: lint_markdown
status: na
- task: lint_package_json
status: passed
- task: lint_repl_help
status: passed
- task: lint_javascript_src
status: passed
- 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
---
7 tasks
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
Planeshifter
changed the title
@stdlib/math/iter packagesmath/iter packages
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
2 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
Two
@stdlib/math/iterfindings are not specific to the TypeScript declarations — the same errors appear consistently across each package's documentation surfaces — so they are fixed package-wide here:special/pow— the summary called the operation the "exponential function", but the iterator evaluatesbase^exponent(the power function). Reworded to "power function (i.e.,baseraised to the powerexponent)" in the declaration, README, REPL help,libJSDoc, andpackage.jsondescription. The auto-generated "See Also" entries (which derive from other packages' metadata) are left untouched.sequences/integers— the documented default for theiteroption was18014398509481984, two more than the actual defaultFLOAT64_MAX_SAFE_INTEGER * 2 = 18014398509481982. Corrected in the declaration, README, REPL help, andlib/main.jsJSDoc.Split out from the
@stdlib/math/iterdeclarations PR (#12462) so the fixes apply consistently across all documentation surfaces.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