Repository navigation
docs: add examples - #16029
Merged
Merged
docs: add examples#16029
Conversation
Added missing `benchmark/benchmark.js` (present in 56 of 57 `@stdlib/stats` siblings, 98%) and the corresponding `directories.benchmark` entry in `package.json` (98% of siblings). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LMYQtSzimuL2KBLtWEqocz
Added missing `@example` to the main function JSDoc in `lib/main.js` (present in 52 of 57 `@stdlib/stats` siblings, 91%). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LMYQtSzimuL2KBLtWEqocz
Added missing `@example` to the main function JSDoc in `lib/main.js` (present in 52 of 57 `@stdlib/stats` siblings, 91%). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LMYQtSzimuL2KBLtWEqocz
Added missing `@example` to the main function JSDoc in `lib/main.js` (present in 52 of 57 `@stdlib/stats` siblings, 91%). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LMYQtSzimuL2KBLtWEqocz
Added missing `@example` to the main function JSDoc in `lib/main.js` (present in 52 of 57 `@stdlib/stats` siblings, 91%). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LMYQtSzimuL2KBLtWEqocz
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
marked this pull request as ready for review
October 11, 2026 12:33
stats packages and benchmarks for stats/kde2dstats packages
kgryte
approved these changes
Oct 11, 2026
stats packages
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:
@stdlib/stats/kde2dand adds missing main-function JSDoc examples to four@stdlib/statspackages, bringing each outlier in line with its siblings.@stdlib/stats/kde2dOnly non-namespace
statspackage without benchmarks. Addsbenchmark/benchmark.js(present in 56/57 siblings, 98%), covering the default call and thenoption, and the matchingdirectories.benchmarkentry inpackage.json(98%). Benchmark structure followsstats/lowess.@stdlib/stats/anova1Main function JSDoc in
lib/main.jslacked an@example(present in 52/57 siblings, 91%). Example taken fromlib/index.js, with the multi-line/* returns */block collapsed to// returns {...}.@stdlib/stats/binomial-testMain function JSDoc in
lib/main.jslacked an@example(91% of siblings). Adds both examples fromlib/index.js: default call and customp/alphaoptions.@stdlib/stats/ttest2Main function JSDoc in
lib/main.jslacked an@example(91% of siblings). Uses the Student's sleep data from the README rather than theincrspace-based module example, so the example is self-contained.@stdlib/stats/ztest2Main function JSDoc in
lib/main.jslacked an@example(91% of siblings). Example taken verbatim fromlib/index.js, minus therequireline.Related Issues
None.
Questions
No.
Other
Namespace summary.
@stdlib/statshas 62 direct child packages; the 5 namespace aggregators (array,base,incr,iter,strided) were excluded, leaving 57 voting members (majority threshold: 43, or 75%). Analyzed features: file tree,package.jsonkey sets (top-level,scripts,directories), README##/###sections,manifest.jsonkeys, test/benchmark/example file names, public signature, return kind, validation prologue, error construction, JSDoc shape, and@stdlibdependencies. Features with a clear majority: file tree,package.jsonkeys, README## Usage/## Examples, return kind, JSDoc@returns/@throws/param descriptions, and JSDoc@example. Features without a clear majority, excluded: README## Notes(70%),test.assign.js/benchmark.assign.js(65%, ndarray reductions only), error construction (format46%, plain-string 49%, mixed 5%), and public signature (11 distinct shapes).Validation. Structural features were extracted from the filesystem. Semantic features were extracted from
lib/main.js,lib/index.jsandlib/validate.jsby agents. Each candidate was then checked by three separate agent reviews: semantic intent, cross-referencing tests, examples and docs, and structural applicability. Before review, benchmark presence was confirmed stdlib-wide (92% of packages with alib/main.js). Excluded: package-specific implementation files, andstats/lowess. Its main function is declared asmain, so alowess( ... )example with a// returnsannotation would failstdlib/jsdoc-doctest; that one needs a maintainer decision. Smoke-tested locally: thekde2dbenchmark (via a harness shim, sincenode_modulesis not installed) and every added example call.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 API drift detection run (majority vote across
@stdlib/statspackages).🤖 Generated with Claude Code
https://claude.ai/code/session_01LMYQtSzimuL2KBLtWEqocz
Generated by Claude Code