chore: correct keyword and JSDoc @returns type in ml/base/kmeans#12867
Draft
Planeshifter wants to merge 2 commits into
Draft
chore: correct keyword and JSDoc @returns type in ml/base/kmeans#12867Planeshifter wants to merge 2 commits into
@returns type in ml/base/kmeans#12867Planeshifter wants to merge 2 commits into
Conversation
Replace plural `algorithms` topic keyword with singular `algorithm` to match the convention used by the four sibling `algorithm-*` packages and by every package in the parallel `metric-*` family (9/10 packages in the namespace use the singular topic-keyword form).
Replace `{StringArray}` with `{Array<string>}` so the JSDoc matches
this package's own TypeScript declaration and REPL signature
(`Array<string>`), as well as the JSDoc on the parallel
`ml/base/kmeans/algorithms` package.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
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:
ml/base/kmeansnamespace surfaced by a structural+semantic diff against sibling packages.ml/base/kmeans/algorithmsReplaces the plural
algorithmstopic keyword inpackage.jsonwith the singularalgorithm. Every other algorithm-family package (algorithm-enum2str,algorithm-str2enum,algorithm-resolve-enum,algorithm-resolve-str) tags itself with the singularalgorithm, and the parallelmetric-*family is uniformly singular as well. Singular topic-keyword conformance across the namespace: 9/10 (90%).ml/base/kmeans/metricsReplaces
@returns {StringArray}with@returns {Array<string>}inlib/main.js. The package's owndocs/types/index.d.tsalready declaresArray<string>, anddocs/repl.txtreportsout: Array<string>. The siblingml/base/kmeans/algorithmsJSDoc also usesArray<string>. TheStringArrayform inmetrics/lib/main.jswas the lone outlier across these five doc surfaces.No observable behavior, signatures, or test expectations change.
Related Issues
This pull request has the following related issues:
Questions
No.
Other
Findings sourced from a cross-package structural and semantic diff of the ten packages in
ml/base/kmeans/. Other candidates inspected and deliberately excluded: theNotesREADME section (semantically warranted only instr2enum/resolve-enumpackages whose output is an opaque integer); theC APIssection (semantically warranted only in the two C-binding packages); and any signature/validation differences between thealgorithm-*andmetric-*families (legitimate semantic mirroring, not drift).Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was written by Claude Code as part of a cross-package drift detection routine over the
ml/base/kmeansnamespace.@stdlib-js/reviewers
Generated by Claude Code