Repository navigation
docs: fix parameter names - #15928
Merged
Merged
Conversation
Renamed `@param a` and `@param b` to `@param d1` and `@param d2` to match the function signature, and realigned the `@return` column accordingly. `d1`/`d2` parameter documentation is used in 7 of 9 (78%) native sibling packages in `stats/base/dists/f`. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WPC1t4Bd9JXeZ7HAuFDETK
…tation Renamed `@param a` and `@param b` to `@param d1` and `@param d2` to match the function signature, and realigned the `@return` column accordingly. `d1`/`d2` parameter documentation is used in 7 of 9 (78%) native sibling packages in `stats/base/dists/f`. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WPC1t4Bd9JXeZ7HAuFDETK
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
Planeshifter
marked this pull request as ready for review
October 6, 2026 15:44
kgryte
approved these changes
Oct 12, 2026
stats/base/dists/f/mode and stats/base/dists/f/skewness
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
This pull request:
@param a/@param btags in the C implementations ofstats/base/dists/f/modeandstats/base/dists/f/skewnesstod1/d2, matching the function signatures and 7 of 9 (78%) native siblings instats/base/dists/f.stats/base/dists/f/modesrc/main.cdocuments@param aand@param b, but the signature isstdlib_base_dists_f_mode( const double d1, const double d2 ). Renamed the tags tod1andd2and realigned@return, matching 78% of native siblings and the package's own README C API section.stats/base/dists/f/skewnessSame drift as
mode:src/main.cdocumentsaandbagainst ad1,d2signature. Renamed the tags and realigned@return(78% conformance). Comment-only change. No behavior change.Related Issues
None.
Questions
No.
Other
Namespace summary.
stats/base/dists/fhas 11 members and none are autogenerated, so the majority threshold is ⌈11 × 0.75⌉ = 9 packages (for C-only features, 7 of the 9 native packages). Features analyzed: file tree,package.jsonkeys,manifest.jsonshape and dependencies, README headings, native boilerplate (binding.gyp,include.gypi, Makefiles,addon.c), JS and C validation prologues, and JS and C doc tags. Clear majorities: file tree,package.jsonkeys, README headings,manifest.jsonkeys and JS doc tags. No clear majority: the C validation prologue (4/9 checkis_nanexplicitly, 5/9 do not) and the JS prologue order (grouped vs. interleaved NaN checks).Validation. Excluded on purpose:
cdfhas no native implementation, which is not a mechanical fix. feat: add C implementation forstats/base/dists/f/cdf#14692 already proposes it.ctorhas a different API shape, which is intentional.quantilehas C++ fixtures in place of Julia fixtures, which is intentional.pdfuses noepsin its C benchmark and example, because it generates inputs differently.entropyreturns{number}instead of{PositiveNumber}. Entropy can be negative.The changed lines are doc comments only. Tests, examples and generated artifacts are untouched.
Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was written primarily by Claude Code as part of an automated cross-package drift-detection run.
@stdlib-js/reviewers
🤖 Generated with Claude Code
https://claude.ai/code/session_01WPC1t4Bd9JXeZ7HAuFDETK
Generated by Claude Code