Repository navigation
docs: add example - #16158
Merged
Merged
docs: add example#16158
Conversation
Added an `@example` block to the main function JSDoc in `lib/main.js` (present in 56 of 57, or 98%, of `@stdlib/stats` siblings). `lowess` was omitted from the recent sweep which added examples to `anova1`, `binomial-test`, `ttest2`, and `ztest2`. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QwjLXc44QKrGGim1D59r9Q
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 14, 2026 20:47
kgryte
approved these changes
Oct 14, 2026
stats/lowess
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:
@exampleblock to the main function JSDoc in@stdlib/stats/lowess, bringing it in line with every other package in the@stdlib/statsnamespace.@stdlib/stats/lowesslib/main.jsdocuments parameters, throws, and return value but has no@example. 56 of the 57 non-namespace@stdlib/statspackages (98%) have one. The recent sweep that added examples toanova1,binomial-test,ttest2, andztest2skippedlowess. The example uses the first ten observations from the README data, callsmain(inside this file,lowessrefers to the internal./lowess.jsroutine), and uses the// returns {...}annotation used byttest2andanova1.Related Issues
None.
Questions
No.
Other
Namespace summary. 57 non-namespace members of
@stdlib/statswere checked. The namespace aggregatesarray,base,incr,iter, andstridedwere excluded. A feature counts as a clear majority when at least 75% (≥43) of packages share it.package.jsonkey set, test/benchmark/example file names, README<section>set,returnKind, JSDoc@returns/@paramdescriptions, and JSDoc@examplepresence.## Notes(70%), error construction (65% have no throws), public signature shape (39%), validation prologue, and@throwstag sequence (51%).Validation. Structural features were extracted from the filesystem. Semantic features were extracted by a separate agent for each package, and each candidate fix was then checked by reviewers for semantic intent and for whether anything relies on the current behavior. Excluded:
benchmark/instats/kde2d, which is already proposed in bench: add benchmarks tostats/kde2d#16127;format()call without placeholders exists in the repo), so it is not drift.The change is comment-only and changes no behavior, signatures, or tests.
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 check for API drift across packages in a namespace.
@stdlib-js/reviewers
🤖 Generated with Claude Code
https://claude.ai/code/session_01QwjLXc44QKrGGim1D59r9Q
Generated by Claude Code