docs: trim stale @param tags in three _tools/makie/plugins plugins#11980
Open
Planeshifter wants to merge 3 commits intodevelopfrom
Open
docs: trim stale @param tags in three _tools/makie/plugins plugins#11980Planeshifter wants to merge 3 commits intodevelopfrom
@param tags in three _tools/makie/plugins plugins#11980Planeshifter wants to merge 3 commits intodevelopfrom
Conversation
…gs-names` The plugin's JSDoc documented a `subpath` parameter that the function signature does not accept and the body never references. Removed the stale tag so the JSDoc matches the actual `( dir, cwd )` signature, in line with the namespace convention (e.g. `makie-repl` documents only the parameters its implementation uses). The 3-param signature is the majority pattern at 19/23 (82.6%); the trimmed-JSDoc-matches-signature sub-pattern is the convention for the minority of plugins that legitimately accept fewer parameters.
…mplexity` The plugin's JSDoc documented `cwd` and `subpath` parameters that the function signature does not accept and the body never references. Removed the stale tags so the JSDoc matches the actual `( dir )` signature. The 3-param signature is the majority pattern at 19/23 (82.6%); the convention for the minority that legitimately take fewer parameters is to document only what the implementation accepts (e.g. `makie-repl`).
The plugin's JSDoc documented `cwd` and `subpath` parameters that the function signature does not accept and the body never references. Removed the stale tags so the JSDoc matches the actual `( dir )` signature. The 3-param signature is the majority pattern at 19/23 (82.6%); the convention for the minority that legitimately take fewer parameters is to document only what the implementation accepts (e.g. `makie-repl`).
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:
@paramJSDoc tags from three plugins in@stdlib/_tools/makie/pluginswhose JSDoc documented parameters that theirpluginfunction neither declares nor uses. The documentation now matches each function's actual signature.Namespace summary
@stdlib/_tools/makie/pluginspackage.jsonshape, public function signature, JSDoc@paramtags, helper-callback set, dependency set, error-construction stylepackage.jsontop-level keys (100%), keyword prefixestools/makie/make/makefile/plugin(100%),( dir, cwd, subpath )signature (19/23 = 82.6%),process+child_process.spawndependency pair (22/23 = 95.7%),onError/onFinishhelper callbacks (22/23 = 95.7%),stdout/stderrhelper callbacks (21/23 = 91.3%)Per-outlier corrections
makie-list-pkgs-namesRemoves a stale
@param {string} subpathJSDoc tag from thepluginfunction, which accepts two parameters(dir, cwd)and does not referencesubpathin its implementation. Across the_tools/makie/pluginsnamespace, 82.6% of packages defineplugin( dir, cwd, subpath ); this package is among those whose signatures legitimately differ, and the documentation now reflects the actual interface. No runtime behavior changes.makie-view-complexityThe
pluginfunction accepts a singledirparameter, which it uses as the working directory when spawning themake view-complexityprocess. JSDoc contained two stale@paramtags —cwdandsubpath— for arguments the function neither declares nor uses; both have been removed. The corrected documentation matches the implementation and reflects the same convention applied to the other plugins in this namespace whose signatures diverge from the 82.6%(dir, cwd, subpath)norm.makie-view-covRemoves stale
@param {string} cwdand@param {string} subpathJSDoc tags frommakie-view-cov, which accepts a singledirargument and invokes theview-covmake target with no additional parameters. The function signature(dir, cwd, subpath)is the documented convention in 82.6% of packages in the_tools/makie/pluginsnamespace; this package is one of three that legitimately diverge, and its documentation now reflects only what the implementation accepts. No logic was changed.Validation
package.jsonkeys, README sections, manifest keys, test/benchmark/example file naming. All 23 plugins share an identical 3-file layout (lib/index.js,lib/main.js,package.json) and identical 16-keypackage.jsonshape; no structural drift was found.@paramtags in the three packages above.makie-repl); helper-callback differences inmakie-replandmakie-stats-list-contributors, which usestdio: 'inherit'and intentionally do not capturestdout/stderr; keyword-array variation, which has no clear majority beyond the shared 5-keyword prefix.Related Issues
None.
Questions
None.
Other
The branch contains 54 commits of unrelated prior work that were already pushed before this drift run started. The three drift commits at
HEAD~2..HEADare the only changes proposed by this PR. Cherry-pick or filter as appropriate when reviewing.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 extracts structural and semantic features from every package in a randomly-picked namespace, identifies the majority pattern per feature at the 75% threshold, runs a multi-agent triage on the outliers (semantic-review, cross-reference, structural-review), and applies only those mechanical corrections that survive triage. The three corrections in this PR were each independently confirmed as JSDoc-vs-implementation drift by the triage agents; the function bodies were left untouched.
@stdlib-js/reviewers
Generated by Claude Code