Skip to content

docs: add @example JSDoc tag in process/node-version#11948

Merged
kgryte merged 1 commit intodevelopfrom
claude/inspiring-curie-uEvzp
May 5, 2026
Merged

docs: add @example JSDoc tag in process/node-version#11948
kgryte merged 1 commit intodevelopfrom
claude/inspiring-curie-uEvzp

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Description

This pull request:

  • Adds a missing @example JSDoc tag to lib/main.js in @stdlib/process/node-version. 11 of 12 sibling packages in @stdlib/process (~92%) carry an @example block in lib/main.js; node-version was the only outlier. The added example mirrors the argv/env style (a console.log of the exported constant followed by a // => comment).

Related Issues

No.

Questions

No.

Other

Per-package conformance: @example present in lib/main.js for 11/12 (~92%) of @stdlib/process packages prior to this change; this PR closes the gap.

Checklist

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

This PR was written primarily by Claude Code as part of an automated cross-package API drift detection routine. The routine extracted structural and semantic features from every package in the @stdlib/process namespace, identified @example presence in lib/main.js as a feature with a clear majority (11/12), and proposed adding the missing tag to node-version. Three independent validator agents (semantic-review, cross-reference, structural-review) confirmed the deviation as drift rather than intentional. The example body itself is a two-line console.log/// => snippet consistent with argv and env.


@stdlib-js/reviewers


Generated by Claude Code

Adds a missing `@example` tag to `lib/main.js` for `@stdlib/process/node-version`
to align with the rest of the namespace. 11 of 12 sibling packages in
`@stdlib/process` (~92%) carry an `@example` block in `lib/main.js`; node-version
was the only outlier.

https://claude.ai/code/session_01HfYzjX5F2cJnQrKbPhbGNB
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
process/node-version $\color{green}154/154$
$\color{green}+100.00%$
$\color{green}6/6$
$\color{green}+100.00%$
$\color{green}0/0$
$\color{green}+100.00%$
$\color{green}154/154$
$\color{green}+100.00%$

The above coverage report was generated for the changes in this PR.

@Planeshifter Planeshifter marked this pull request as ready for review May 5, 2026 14:26
@Planeshifter Planeshifter requested review from a team and kgryte May 5, 2026 14:26
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label May 5, 2026
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels May 5, 2026
@kgryte kgryte merged commit 2ae311a into develop May 5, 2026
54 checks passed
@kgryte kgryte deleted the claude/inspiring-curie-uEvzp branch May 5, 2026 22:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements, additions, or changes to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants