Skip to content

bench: add missing function documentation and ensure consistency with other benchmarks#13221

Merged
kgryte merged 1 commit into
developfrom
philipp/fix-commit-review-2026-07-01
Jul 1, 2026
Merged

bench: add missing function documentation and ensure consistency with other benchmarks#13221
kgryte merged 1 commit into
developfrom
philipp/fix-commit-review-2026-07-01

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Follow-up fixes for commits merged to develop between 2026-06-30 14:47 PDT (14c51b7f3) and 2026-07-01 01:30 CDT (aebd92a2a).

Description

Small style follow-ups against the eight commits merged to develop in the last 24 hours. Only stats/base/dists/anglit/quantile needed changes; the other three new distribution packages (poisson/entropy C addition, lognormal/logpdf C addition, log-logistic/pdf) and the four bot/namespace commits came in clean.

Fixes in this PR:

  • Static helper functions in the anglit quantile benchmark lacked the /** ... */ doc comments every sibling benchmark.c uses. Added matching doc comments to print_version, print_summary, print_results, tic, random_uniform, benchmark, and main. (aebd92a2a, lib/node_modules/@stdlib/stats/base/dists/anglit/quantile/benchmark/c/benchmark.c)
  • isnan( y ) in lib/node_modules/@stdlib/stats/base/dists/anglit/quantile/benchmark/c/benchmark.c broke with the tree's established y != y self-comparison idiom for NaN checks, dragging in an unneeded <math.h>. Switched both call sites to y != y and dropped the include. (aebd92a2a, lib/node_modules/@stdlib/stats/base/dists/anglit/quantile/benchmark/c/benchmark.c)

Related Issues

None.

Questions

No.

Other

Validation. Reviewed all eight commits merged to develop in the window with four parallel reviewers (two style, two bug-hunt). Checked for stdlib code style compliance, copy-paste artefacts, math/logic bugs, boundary handling, contract mismatches, wrong constants, and manifest/addon wiring. Findings that were not independently re-verifiable against a sibling reference package, or that would require touching code outside the window's diff, were deliberately excluded. The three sibling C benchmarks added in the same window (poisson/entropy, lognormal/logpdf, log-logistic/pdf) served as the reference for the anglit benchmark fix.

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 PR was authored by Claude Code as part of a scheduled routine that audits recent commits to develop. The reviewer agents surfaced the two style deviations above; the fixes mirror the doc-comment scaffold and NaN-check idiom already used by the three sibling C benchmarks added in the same window.


@stdlib-js/reviewers


Generated by Claude Code

…ing packages

Add missing function documentation comments and use the `y != y` self-comparison
idiom for NaN checks (dropping the now-unused `<math.h>` include), matching
the C benchmark scaffold used by the other stats/base/dists packages added
in this window (poisson/entropy, lognormal/logpdf, log-logistic/pdf).
@stdlib-bot stdlib-bot added the Statistics Issue or pull request related to statistical functionality. label Jul 1, 2026
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/anglit/quantile $\\color{green}297/297$
$\\color{green}+100.00\\%$
$\\color{green}27/27$
$\\color{green}+100.00\\%$
$\\color{green}4/4$
$\\color{green}+100.00\\%$
$\\color{green}297/297$
$\\color{green}+100.00\\%$

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

@Planeshifter Planeshifter marked this pull request as ready for review July 1, 2026 13:37
@Planeshifter Planeshifter requested review from a team and kgryte July 1, 2026 13:37
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jul 1, 2026
@kgryte kgryte removed the Needs Review A pull request which needs code review. label Jul 1, 2026
@kgryte kgryte changed the title style: align stats/base/dists/anglit/quantile C benchmark with sibling packages bench: add missing function documentation and ensure consistency with other benchmarks Jul 1, 2026
@kgryte kgryte merged commit fe3bace into develop Jul 1, 2026
56 checks passed
@kgryte kgryte deleted the philipp/fix-commit-review-2026-07-01 branch July 1, 2026 19:58
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