Skip to content

docs: fix package-wide doc errors in four math/base/special packages#12474

Open
Planeshifter wants to merge 1 commit into
developfrom
philipp/docs-fix-base-special-package-wide
Open

docs: fix package-wide doc errors in four math/base/special packages#12474
Planeshifter wants to merge 1 commit into
developfrom
philipp/docs-fix-base-special-package-wide

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

These @stdlib/math/base/special 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 — 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 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 reworded 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 (#12467) so the fixes apply consistently across all documentation surfaces.

Related Issues

Does this pull request have any related issues?

No.

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request?

Found via a TypeScript-declaration audit of the @stdlib/math namespace.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

If you answered "yes" to using AI assistance, please provide a short 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

… 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
---
@stdlib-bot stdlib-bot added the Math Issue or pull request specific to math functionality. label Jun 3, 2026
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
math/base/special/cscd $\color{green}186/186$
$\color{green}+100.00\%$
$\color{green}5/5$
$\color{green}+100.00\%$
$\color{green}2/2$
$\color{green}+100.00\%$
$\color{green}186/186$
$\color{green}+100.00\%$
math/base/special/nonfibonacci $\color{green}215/215$
$\color{green}+100.00\%$
$\color{green}12/12$
$\color{green}+100.00\%$
$\color{green}2/2$
$\color{green}+100.00\%$
$\color{green}215/215$
$\color{green}+100.00\%$
math/base/special/nonfibonaccif $\color{green}210/210$
$\color{green}+100.00\%$
$\color{green}12/12$
$\color{green}+100.00\%$
$\color{green}2/2$
$\color{green}+100.00\%$
$\color{green}210/210$
$\color{green}+100.00\%$
math/base/special/powf $\color{red}1219/1253$
$\color{green}+97.29\%$
$\color{red}98/101$
$\color{green}+97.03\%$
$\color{red}8/10$
$\color{green}+80.00\%$
$\color{red}1219/1253$
$\color{green}+97.29\%$

The above coverage report was generated for the changes in this PR.

@Planeshifter Planeshifter marked this pull request as ready for review June 3, 2026 03:33
@Planeshifter Planeshifter requested review from a team and kgryte June 3, 2026 03:33
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jun 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Math Issue or pull request specific to math functionality. Needs Review A pull request which needs code review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants