docs: align _tools/pkgs/* outliers with namespace JSDoc conventions#11763
docs: align _tools/pkgs/* outliers with namespace JSDoc conventions#11763Planeshifter wants to merge 6 commits into
_tools/pkgs/* outliers with namespace JSDoc conventions#11763Conversation
Added missing `@returns {void}` JSDoc tag on the primary function (present in 88% of siblings in `_tools/pkgs/`).
Added missing `@returns {void}` JSDoc tag on the primary function (present in 88% of siblings in `_tools/pkgs/`).
Added missing `@returns {void}` JSDoc tag on the primary function (present in 88% of siblings in `_tools/pkgs/`).
Reverting — drift finding was a false positiveThe
Neither side clears the 75% majority threshold, so there is no clear-majority drift for this feature. The original routine run reported 22/25 = 88% conformance because the per-package semantic-extraction agents conflated the primary function's JSDoc with inner-callback JSDocs ( The stdlib ESLint config also tells against the edit: Pushed three revert commits (one per outlier package) to restore the originals. The branch is now a no-op against Filed under false-positive causes for future drift runs: the semantic-extraction agent prompt needs to pin analysis to the top-level function's JSDoc and explicitly ignore nested callback JSDocs. Generated by Claude Code |
Description
Aligning outliers in
_tools/pkgswith namespace majority patterns (random namespace pick, seed20260424).Namespace summary
_tools/pkgspackage.jsonshape, README section structure, test/benchmark/example/lib/docs/etc/bin file naming, public signature, return kind, validation prologue, error construction, JSDoc shape,@stdlib/*dependency set.package.jsonkeys (100%),directories.{doc,example,lib}(100%),docs/usage.txt(100%),etc/cli_opts.json(100%),bin/cli(100%),examples/index.js(100%), H2Usage/CLI(100%) andExamples(96%), H3Usage/Examples(100%) andNotes(92%),directories.test(96%),errorConstruction=format(100%),jsdocShape.hasExample=true(100%),returnKind=void(84%), JSDoc@returnspresent (88%), and the core@stdlib/assert/*+@stdlib/string/format+@stdlib/utils/copydependency set (≥84%).lib/helpers),lib/*file naming,scriptskeys (empty across all members), JSDocoptionsparamTaghasDescription(13 true / 10 false — 52% — below threshold), H2Notes(64%)._tools/pkgs/addonsAdds a missing
@returns {void}JSDoc tag to the primary function in_tools/pkgs/addons/lib/async.js, bringing it in line with 22 of the 25 non-autogenerated packages in the_tools/pkgs/namespace (88% conformance). The tag is inserted between the last@throwsand the@exampleblock, matching the ordering convention used by sibling packages. Reviewers can verify placement against any of the conforming siblings in_tools/pkgs/._tools/pkgs/browser-depsFixes JSDoc drift in
_tools/pkgs/browser-depsrelative to the_tools/pkgs/namespace. Added missing@returns {void}JSDoc tag topkgDepsinlib/async.js, placing it between the last@throwsand the@exampleblock to match the 22/25 (88%) siblings that already carry the tag. Reviewers can confirm conformance by scanning the remaining_tools/pkgs/members for the same pattern._tools/pkgs/depsFixes JSDoc drift in
_tools/pkgs/depsrelative to the_tools/pkgs/namespace. Added missing@returns {void}JSDoc tag topkgDepsinlib/async.js, placing it between the last@throwsand the@exampleblock to match the convention followed by 22 of 25 siblings (88% conformance). Reviewers can diff against any conforming peer (e.g.,_tools/pkgs/entry-pointsor_tools/pkgs/browser-entry-points) to confirm alignment.Validation
Checks performed:
package.jsonshape, README headings, test/benchmark/example/lib/docs/etc/bin file naming).@stdlib/*dependency set).Deliberately excluded:
optionsparamTag description, H2Notes, file-tree as a whole, lib/* naming).installedoutlier ondirectories.testinpackage.json— the package has notest/directory on disk, so adding the field would advertise a non-existent path. Structural and cross-reference agents both flagged this as intentional-deviation / needs-human. Logged for follow-up.returnKind=valueoutliers (dep-list,name2bucket,name2standalone,namespace-deps) — these are genuinely synchronous pure-value functions; not drift.Related Issues
None.
Questions
No.
Other
Produced by the drift-detection routine with seed
20260424. Full per-feature breakdown, the outlier list with drop reasons, and the list of namespaces surveyed during eligibility enumeration are saved in a local report outside the working tree.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was produced by an automated cross-package drift-detection routine running under Claude Code. The routine picked the
_tools/pkgsnamespace at random (seed20260424), extracted structural and semantic features from all 25 non-autogenerated members, identified the majority pattern for each feature, validated candidate corrections via three independent sub-agents (semantic-review, cross-reference, structural-review), and emitted purely mechanical JSDoc edits for the three outliers that survived filtering. No public behavior, tests, or signatures were modified.Generated by Claude Code