docs: update JSDoc comments

[Planeshifter]

Description

What is the purpose of this pull request?

This pull request:

• fixes JSDoc in three _tools/makie/plugins packages that differed from the convention shared by nearly all of their siblings. Two of the three are documentation errors.

Namespace summary. 23 members, none autogenerated. Checked: file tree, package.json key sets, scripts/stdlib key sets, README/manifest presence, test/benchmark/example files, public signature, return kind, validation prologue, error construction, JSDoc shape and dependencies. All structural features are 100% uniform: every package contains only lib/index.js, lib/main.js and package.json. Semantic features with a clear majority (≥75%): JSDoc example shape, private-callback JSDoc tags, and the description matching between index.js and main.js. Signature and validation features have no clear majority because some plugins take no subpath or cwd. They were excluded.

makie-benchmark-lang

The @example in lib/index.js registered the plugin under benchmark and invoked benchmark, a leftover from makie-benchmark. etc/.makie.js registers it as benchmark-lang, and the example now uses that name. In 22/23 siblings (96%) the example key equals the registered command name.

makie-markdown-asset-link

Removes @returns {void} from the private onError callback, which has no return statement. The tag is absent in 21/22 siblings that define onError (95%).

makie-list-pkgs

Removes a stray blank line between the require() statements and the options object in the @example. It is absent in 22/23 siblings (96%).

Related Issues

Does this pull request have any related issues?

No.

Questions

Any questions for reviewers of this pull request?

makie-markdown-examples-javascript has a description in lib/main.js ("...in README.md files") that differs from lib/index.js and package.json ("...in Markdown files"). The underlying make rule filters on README.md, so main.js is arguably the accurate one. This PR leaves it unchanged. Which wording should be canonical?

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

Validation. Structural features were extracted directly from the filesystem. Semantic features came from source diffs of every lib/main.js and lib/index.js against a reference sibling. Two independent review passes then checked each candidate: one for intentional versus unintentional deviation, and one for repo-wide reliance on the current text. Deliberately excluded:

• the makie-install-node-addons local child variable. The majority's var proc shadows the module-level proc, so the outlier is the better pattern.
• the makie-markdown-examples-javascript description, which needs a human decision (see Questions).
• copyright-year differences, which reflect when each file was created.
• signature differences in makie-repl, makie-list-pkgs-names, makie-view-cov and makie-view-complexity, which are intentional.

All changes are JSDoc only, with no behavior change.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

• Read, understood, and followed the contributing guidelines.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

• Yes
• No

If you answered "yes" above, how did you use AI assistance?

• Code generation (e.g., when writing an implementation or fixing a bug)
• Test/benchmark generation
• Documentation (including examples)
• Research and understanding

Disclosure

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

This PR was written primarily by Claude Code, as part of an automated cross-package API drift detection run.

---

@stdlib-js/reviewers

🤖 Generated with Claude Code

https://claude.ai/code/session_01LCsdkkh843smiUCvB2GZqx

---

Generated by Claude Code