docs: remove orphan @param tags in _tools/makie/plugins#12288
Closed
Planeshifter wants to merge 3 commits into
Closed
docs: remove orphan @param tags in _tools/makie/plugins#12288Planeshifter wants to merge 3 commits into
@param tags in _tools/makie/plugins#12288Planeshifter wants to merge 3 commits into
Conversation
…ie-list-pkgs-names`
The function signature accepts `(dir, cwd)` but the JSDoc carried an
extra `@param {string} subpath` tag for a parameter the function does
not accept. Removed the orphan tag so the JSDoc matches the actual
signature.
Sibling consistency: 20 of 23 plugins in `_tools/makie/plugins` have
JSDoc `@param` counts matching their function signatures (87%); the
3 outliers all share the same copy-pasted-template residue pattern.
…kie-view-complexity`
The function signature accepts `(dir)` but the JSDoc carried extra
`@param {string} cwd` and `@param {string} subpath` tags for
parameters the function does not accept. Removed the orphan tags so
the JSDoc matches the actual signature.
Sibling consistency: 20 of 23 plugins in `_tools/makie/plugins` have
JSDoc `@param` counts matching their function signatures (87%).
…kie-view-cov`
The function signature accepts `(dir)` but the JSDoc carried extra
`@param {string} cwd` and `@param {string} subpath` tags for
parameters the function does not accept. Removed the orphan tags so
the JSDoc matches the actual signature.
Sibling consistency: 20 of 23 plugins in `_tools/makie/plugins` have
JSDoc `@param` counts matching their function signatures (87%).
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:
@paramtags in three_tools/makie/plugins/*packages so that the documented parameters match what each plugin'sfunction plugin( ... )actually accepts. No behavior change; documentation-only edits tolib/main.js.Namespace summary
@stdlib/_tools/makie/pluginspackage.jsontop-level/scripts/stdlibkeys,engines/directories/license/mainvalues, READMEs,manifest.json,test//benchmark//examples/contents. No structural drift — every member shares an identical scaffold.lib/main.jsmodule imports, function signature, helper function set, listener wiring on the spawned child,stdiosetting, JSDoc shape on the exported plugin,lib/index.jsmodule-level tags.(dir, cwd, subpath)(83%), JSDoc@paramcount matching signature arity (87%), helper-set presence (91-96%),proc.on('error'/'close', ...)wiring (91%), explicitstdout/stderrdata handlers (87%), absence ofstdio: 'inherit'(91%).keywordsarray length (mode reaches only 22%); legitimately varies per plugin.Per outlier package
@stdlib/_tools/makie/plugins/makie-list-pkgs-namesSignature is
plugin( dir, cwd ). JSDoc carried a third@param {string} subpaththat the function never accepts and never references in its body. Removed the orphan tag. The body usescwdas the make-target'sSRC_DIRenv var; nosubpathcodepath exists. Matches the project convention of trimming JSDoc to the actual signature (seemakie-repl, which correctly documents only its two real parameters).@stdlib/_tools/makie/plugins/makie-view-complexitySignature is
plugin( dir ). JSDoc carried two orphan tags —@param {string} cwdand@param {string} subpath— for parameters the function neither declares nor uses. The body only referencesdir(foropts.cwd) and hardcodesargs[ 0 ] = 'view-complexity'. Removed both orphan tags.@stdlib/_tools/makie/plugins/makie-view-covSignature is
plugin( dir ). JSDoc carried the same two orphan tags asmakie-view-complexity. The body only usesdirandargs = [ 'view-cov' ]. Removed both orphan tags.Validation
What was checked:
package.jsonshape, READMEs,manifest.json, test/benchmark/example layout).lib/main.jsandlib/index.js(signature, helper set, listener wiring,stdioflag, JSDoc@param/@returnscounts).test/,examples/,.d.ts,repl.txt, or external JSDoc consumer is affected, and the only callsite (etc/.makie.jsvia themakiedispatcher) passes args positionally without consulting JSDoc.What was deliberately excluded:
makie-repl— usesstdio: 'inherit'and a 2-arg signature with matching JSDoc; intentional deviation for an interactive REPL.makie-stats-list-contributors— usesstdio: 'inherit'and omits thestdout/stderrdata helpers; internally consistent.makie-install-node-addons— names the spawned-child variablechildrather thanproc; this avoids shadowing theproc = require('process')import and is arguably better than the majority pattern, not drift.keywordsarray length variation — no clear majority; legitimate per-plugin variation.Related Issues
None.
Questions
None.
Other
Diff is 5 deletions across 3 files (-1 in
makie-list-pkgs-names, -2 each inmakie-view-complexityandmakie-view-cov). Each package is committed separately to keep the per-package audit trail readable.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was produced by Claude Code as part of a cross-package drift-detection routine over the
@stdlib/_tools/makie/pluginsnamespace. Structural and semantic features were extracted programmatically across all 23 packages; majority patterns were computed at a 75% threshold; outliers were classified by parallel opus review agents to filter out intentional deviations. The three accepted corrections are mechanical JSDoc-tag deletions with no behavior change.@stdlib-js/reviewers
Generated by Claude Code