docs: align JSDoc throws ordering across stats/array outliers#11838
Open
Planeshifter wants to merge 12 commits intodevelopfrom
Open
docs: align JSDoc throws ordering across stats/array outliers#11838Planeshifter wants to merge 12 commits intodevelopfrom
stats/array outliers#11838Planeshifter wants to merge 12 commits intodevelopfrom
Conversation
Reorder `@throws` JSDoc tags in `lib/main.js` so they match the order in which the corresponding runtime checks fire (`isCollection` array-like check before the `contains` data-type check). Matches the `stats/array` namespace majority pattern (57/69 = 83% list `array-like object` before `supported data type`). JSDoc-only change; no code, test, or example changes.
Reorder `@throws` JSDoc tags in `lib/main.js` so they match the order in which the corresponding runtime checks fire (`isCollection` array-like check before the `contains` data-type check). Matches the `stats/array` namespace majority pattern (57/69 = 83% list `array-like object` before `supported data type`). JSDoc-only change; no code, test, or example changes.
Reorder `@throws` JSDoc tags in `lib/main.js` so they match the order in which the corresponding runtime checks fire (`isCollection` array-like check before the `contains` data-type check). Matches the `stats/array` namespace majority pattern (57/69 = 83% list `array-like object` before `supported data type`). JSDoc-only change; no code, test, or example changes.
Reorder `@throws` JSDoc tags in `lib/main.js` so they match the order in which the corresponding runtime checks fire (`isCollection` array-like check before the `contains` data-type check). Matches the `stats/array` namespace majority pattern (57/69 = 83% list `array-like object` before `supported data type`). JSDoc-only change; no code, test, or example changes.
Reorder `@throws` JSDoc tags in `lib/main.js` so they match the order in which the corresponding runtime checks fire (`isCollection` array-like check before the `contains` data-type check). Matches the `stats/array` namespace majority pattern (57/69 = 83% list `array-like object` before `supported data type`). JSDoc-only change; no code, test, or example changes.
Reorder `@throws` JSDoc tags in `lib/main.js` so they match the order in which the corresponding runtime checks fire (`isCollection` array-like check before the `contains` data-type check). Matches the `stats/array` namespace majority pattern (57/69 = 83% list `array-like object` before `supported data type`). JSDoc-only change; no code, test, or example changes.
Reorder `@throws` JSDoc tags in `lib/main.js` so they match the order in which the corresponding runtime checks fire (`isCollection` array-like check before the `contains` data-type check). Matches the `stats/array` namespace majority pattern (57/69 = 83% list `array-like object` before `supported data type`). JSDoc-only change; no code, test, or example changes.
…ring Reorder `@throws` JSDoc tags in `lib/main.js` so they match the order in which the corresponding runtime checks fire (`isCollection` array-like check before the `contains` data-type check). Matches the `stats/array` namespace majority pattern (57/69 = 83% list `array-like object` before `supported data type`). JSDoc-only change; no code, test, or example changes.
…ring Reorder `@throws` JSDoc tags in `lib/main.js` so they match the order in which the corresponding runtime checks fire (`isCollection` array-like check before the `contains` data-type check). Matches the `stats/array` namespace majority pattern (57/69 = 83% list `array-like object` before `supported data type`). JSDoc-only change; no code, test, or example changes.
…ring Reorder `@throws` JSDoc tags in `lib/main.js` so they match the order in which the corresponding runtime checks fire (`isCollection` array-like check before the `contains` data-type check). Matches the `stats/array` namespace majority pattern (57/69 = 83% list `array-like object` before `supported data type`). JSDoc-only change; no code, test, or example changes.
…ring Reorder `@throws` JSDoc tags in `lib/main.js` so they match the order in which the corresponding runtime checks fire (`isCollection` array-like check before the `contains` data-type check). Matches the `stats/array` namespace majority pattern (57/69 = 83% list `array-like object` before `supported data type`). JSDoc-only change; no code, test, or example changes.
…ring Reorder `@throws` JSDoc tags in `lib/main.js` so they match the order in which the corresponding runtime checks fire (`isCollection` array-like check before the `contains` data-type check). Matches the `stats/array` namespace majority pattern (57/69 = 83% list `array-like object` before `supported data type`). JSDoc-only change; no code, test, or example changes.
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
Aligning outliers in
stats/arraywith namespace majority patterns (random namespace pick, seed1777451199).This pull request:
@throwsJSDoc tags inlib/main.jsfor 12 packages in thestats/arraynamespace so they match the order in which the corresponding runtime checks fire (isCollectionarray-like check beforecontainsdata-type check). 57/69 (83%) of namespace packages already follow this ordering; the 12 stdev/nanstdev family packages had them swapped.Namespace summary
stats/arraypackage.jsonshape, README section sequence,manifest.jsonshape, test/benchmark/examples filenames, public signature, return kind, validation prologue, error construction, JSDoc shape (param/returns/throws/example),@stdlib/*dependency setpackage.jsontop-level keys (100%), README section sequence (100% on theUsage / Notes / Examplesprefix), test/benchmark/examples filenames (100%),returnKind=value(100%),errorConstruction=format(100%),jsdocShape.hasExample=true(100%), JSDoc throws ordering "array-like before data type" (83%)ReferencesREADME section (22%, intentional add-on for packages citing literature)Per-outlier package notes
stats/array/stdevReorder
@throwstags to match runtime check order. The current JSDoc lists the unsupported-data-type error before the non-array-like error, butisCollectionis checked first at runtime. Swap the two tags to restore consistency with the 83% majority of packages in this namespace.stats/array/stdevchReorder
@throwstags to match runtime check order. The current JSDoc lists the unsupported-data-type error before the non-array-like error, butisCollectionis checked first at runtime. Swap the two tags to restore consistency with the 83% majority of packages in this namespace.stats/array/stdevpnReorder
@throwstags to match runtime check order. The current JSDoc lists the unsupported-data-type error before the non-array-like error, butisCollectionis checked first at runtime. Swap the two tags to restore consistency with the 83% majority of packages in this namespace.stats/array/stdevtkReorder
@throwstags to match runtime check order. The current JSDoc lists the unsupported-data-type error before the non-array-like error, butisCollectionis checked first at runtime. Swap the two tags to restore consistency with the 83% majority of packages in this namespace.stats/array/stdevwdReorder
@throwstags to match runtime check order. The current JSDoc lists the unsupported-data-type error before the non-array-like error, butisCollectionis checked first at runtime. Swap the two tags to restore consistency with the 83% majority of packages in this namespace.stats/array/stdevycReorder
@throwstags to match runtime check order. The current JSDoc lists the unsupported-data-type error before the non-array-like error, butisCollectionis checked first at runtime. Swap the two tags to restore consistency with the 83% majority of packages in this namespace.stats/array/nanstdevReorder
@throwstags to match runtime check order. The current JSDoc lists the unsupported-data-type error before the non-array-like error, butisCollectionis checked first at runtime. Swap the two tags to restore consistency with the 83% majority of packages in this namespace.stats/array/nanstdevchReorder
@throwstags to match runtime check order. The current JSDoc lists the unsupported-data-type error before the non-array-like error, butisCollectionis checked first at runtime. Swap the two tags to restore consistency with the 83% majority of packages in this namespace.stats/array/nanstdevpnReorder
@throwstags to match runtime check order. The current JSDoc lists the unsupported-data-type error before the non-array-like error, butisCollectionis checked first at runtime. Swap the two tags to restore consistency with the 83% majority of packages in this namespace.stats/array/nanstdevtkReorder
@throwstags to match runtime check order. The current JSDoc lists the unsupported-data-type error before the non-array-like error, butisCollectionis checked first at runtime. Swap the two tags to restore consistency with the 83% majority of packages in this namespace.stats/array/nanstdevwdReorder
@throwstags to match runtime check order. The current JSDoc lists the unsupported-data-type error before the non-array-like error, butisCollectionis checked first at runtime. Swap the two tags to restore consistency with the 83% majority of packages in this namespace.stats/array/nanstdevycReorder
@throwstags to match runtime check order. The current JSDoc lists the unsupported-data-type error before the non-array-like error, butisCollectionis checked first at runtime. Swap the two tags to restore consistency with the 83% majority of packages in this namespace.Related Issues
This pull request has no related issues.
Questions
No.
Other
Validation
What was checked:
package.jsonkeys/scripts/stdlib/manifest shape, README heading sequence, test/benchmark/examples filenames. Result: identical across the namespace, no structural drift.lib/main.jsfor every package: public signature, return kind, validation prologue, error construction, full JSDoc shape (param tags / returns tag / throws tags / hasExample), and@stdlib/*dependency set.@throwslines is the complete and correct fix. All three returnedconfirmed-driftfor all 12 packages.What was deliberately excluded:
ReferencesREADME section).*-bycallback variants (max-by,min-by,nanmax-by, etc.), whose lack of a data-type predicate check is a legitimate semantic difference, not drift.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code as part of an automated cross-package drift-detection routine. The routine selected the
stats/arraynamespace at random (seed1777451199), extracted structural and semantic features for every member, computed majority patterns at a 75% conformance threshold, ran three independent validation agents, and applied only mechanical JSDoc reorderings whose correctness all three validators confirmed. Each commit is one outlier package.@stdlib-js/reviewers
Generated by Claude Code