Skip to content

docs: update descriptions#12969

Merged
kgryte merged 3 commits into
developfrom
philipp/fix-commit-review-2026-06-19
Jun 20, 2026
Merged

docs: update descriptions#12969
kgryte merged 3 commits into
developfrom
philipp/fix-commit-review-2026-06-19

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

Follow-up fixes for commits merged to develop between 2026-06-18 17:52 UTC and 2026-06-19 06:03 UTC, identified by an automated review of the 13 first-parent commits in that window.

This pull request:

  • Aligns three documentation/declaration omissions that landed in the new fft/base/fftpack/cosqi and stats/base/dists/anglit/mean packages.

Fixes by package

fft/base/fftpack
  • 1fec441 added cosqi to the fftpack namespace lib/index.js but omitted the corresponding import and Namespace interface entry in lib/node_modules/@stdlib/fft/base/fftpack/docs/types/index.d.ts; this commit adds both, inserted alphabetically between cffti and decompose.
stats/base/dists/anglit/mean
  • 82270fb (stats/base/dists/anglit/mean/README.md, line 29): replaced `mu` / `sigma` with `μ` / `σ > 0` in the intro prose to match the Greek-identifier convention used by the median sibling and normal/mean.
  • 82270fb: fixed inconsistent JSDoc verb in lib/node_modules/@stdlib/stats/base/dists/anglit/mean/include/stdlib/stats/base/dists/anglit/mean.h (line 30) — changed "Evaluates" to "Returns" to match the package's JS source, type declarations, and every analogous mean/median header in the repo.

Related Issues

None.

Questions

No.

Other

Window summary

13 first-parent commits, dominated by three feature additions: fft/base/fftpack/cosqi (new FFTPACK port), stats/base/dists/anglit/mean, and stats/base/dists/anglit/median. Remaining commits cover BLAS extended-namespace TypeScript declarations, an internal mean/median/modemain rename in stats/base/dists/t, the new Uint64.from(...)Uint64.from(...) correctness fix and a 1010.0 decimal-literal fix in stats/base/dists/negative-binomial/variance, plus minor doc/test housekeeping (related-packages sections, capitalization, console.log(__filename) removals).

Validation

Two style-compliance review passes (sonnet) and two correctness passes (opus) ran in parallel against the union diff. Findings were filtered against the spec's high-signal criteria: only objective bugs, unambiguous style-guide violations, or typos a maintainer would fix on sight survive.

What was checked:

  • stdlib style-guide compliance against sibling reference packages (fft/base/fftpack/cffti and .../rffti; stats/base/dists/arcsine/mean and .../normal/mean)
  • Namespace synchronization between lib/index.js, docs/types/index.d.ts, and README TOC
  • Math/algorithmic correctness in the diff (cosqi cosine table construction; anglit mean/median formulae)
  • Test fixture / assertion coverage
  • C header safety, fixture buffer sizes, numerical guards

What was deliberately excluded:

  • Anything requiring interpretation or judgment calls (subjective preferences, "could be cleaner")
  • fft/base/fftpack/README.md TOC missing cosqi: auto-generated by stdlib-bot, will be propagated on the next run (see stdlib-bot PR docs: update namespace table of contents #12963 for the blas/ext/base analog in the same window)
  • Mid-scope var declarations in cosqi/examples/index.js and the matching README block: sibling rffti/examples/index.js uses the same pattern, so the layout is established convention, not a violation
  • Issues that would require touching code outside the window's diff to validate

The full per-issue audit log, including dropped false positives with reasoning, is recorded locally for future review.

Checklist

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

This pull request was generated by a scheduled Claude Code routine that audits the prior 24 hours of merges to develop. The routine launched four parallel reviewer subagents (two sonnet style-compliance, two opus correctness), filtered findings against high-signal criteria, applied the surviving fixes mechanically, and drafted this description. A human will audit before promoting the PR out of draft.


@stdlib-js/reviewers


Generated by Claude Code

claude added 2 commits June 19, 2026 12:27
…ions

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017sBYk3mbopdosZJmCL7er6
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017sBYk3mbopdosZJmCL7er6
@stdlib-bot

stdlib-bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Coverage Report

No coverage information available.

@stdlib-bot stdlib-bot added the Statistics Issue or pull request related to statistical functionality. label Jun 20, 2026
@kgryte kgryte marked this pull request as ready for review June 20, 2026 21:37
@kgryte kgryte requested a review from a team June 20, 2026 21:37
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jun 20, 2026
@kgryte kgryte removed the Needs Review A pull request which needs code review. label Jun 20, 2026
@kgryte kgryte changed the title chore: follow-up fixes for develop commits (2026-06-18 to 2026-06-19) docs: update descriptions Jun 20, 2026
@kgryte kgryte merged commit 7f1c224 into develop Jun 20, 2026
52 checks passed
@kgryte kgryte deleted the philipp/fix-commit-review-2026-06-19 branch June 20, 2026 21:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Statistics Issue or pull request related to statistical functionality.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants