docs: fix package-wide doc errors in four math/base/special packages#12474
Open
Planeshifter wants to merge 1 commit into
Open
docs: fix package-wide doc errors in four math/base/special packages#12474Planeshifter wants to merge 1 commit into
math/base/special packages#12474Planeshifter wants to merge 1 commit into
Conversation
… packages
These findings are not specific to the TypeScript declarations; the same
errors appear consistently across each package's documentation surfaces,
so they are corrected package-wide (declaration, README, REPL help, `lib`
JSDoc, C header/source comments, and `package.json` as applicable):
- `cscd`: the garbled summary "Computes the cosecant of a degree." ->
"Computes the cosecant of an angle measured in degrees.".
- `nonfibonaccif`: the garbled summary "...nth non-Fibonacci
single-precision floating-point number." -> "...nth non-Fibonacci
number as a single-precision floating-point number." (matching the
double-precision sibling `nonfibonacci`).
- `nonfibonacci`: the domain Notes said "If not provided a nonnegative
integer value..."; the valid domain is positive integers (`n < 1`
returns `NaN`), so reword to "If provided either a non-integer or
`n < 1`, the function returns `NaN`.".
- `powf`: an `@example` used the double-precision pi literal
`3.141592653589793`; use the single-precision `3.1415927410125732`.
Split out from the `@stdlib/math/base/special` declarations PR so the
fixes apply 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: passed
- 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. |
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
These
@stdlib/math/base/specialfindings are not specific to the TypeScript declarations — the same errors appear consistently across each package's documentation surfaces — so they are corrected package-wide (declaration, README, REPL help,libJSDoc, C header/source comments, andpackage.jsonas applicable):cscd— garbled summary "Computes the cosecant of a degree." → "Computes the cosecant of an angle measured in degrees.".nonfibonaccif— garbled summary "...nth non-Fibonacci single-precision floating-point number." → "...nth non-Fibonacci number as a single-precision floating-point number." (matching the double-precision siblingnonfibonacci).nonfibonacci— the domain Notes said "If not provided a nonnegative integer value..."; the valid domain is positive integers (n < 1returnsNaN), so reworded to "If provided either a non-integer orn < 1, the function returnsNaN.".powf— an@exampleused the double-precision pi literal3.141592653589793; use the single-precision3.1415927410125732.Split out from the
@stdlib/math/base/specialdeclarations PR (#12467) 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