docs: add @example JSDoc tag in process/node-version#11948
Open
Planeshifter wants to merge 1 commit intodevelopfrom
Open
docs: add @example JSDoc tag in process/node-version#11948Planeshifter wants to merge 1 commit intodevelopfrom
@example JSDoc tag in process/node-version#11948Planeshifter wants to merge 1 commit intodevelopfrom
Conversation
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
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
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:
@exampleJSDoc tag tolib/main.jsin@stdlib/process/node-version. 11 of 12 sibling packages in@stdlib/process(~92%) carry an@exampleblock inlib/main.js;node-versionwas the only outlier. The added example mirrors theargv/envstyle (aconsole.logof the exported constant followed by a// =>comment).Related Issues
No.
Questions
No.
Other
Per-package conformance:
@examplepresent inlib/main.jsfor 11/12 (~92%) of@stdlib/processpackages prior to this change; this PR closes the gap.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
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/processnamespace, identified@examplepresence inlib/main.jsas a feature with a clear majority (11/12), and proposed adding the missing tag tonode-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-lineconsole.log/// =>snippet consistent withargvandenv.@stdlib-js/reviewers
Generated by Claude Code