chore: fix JavaScript lint errors (issue #11247)#11672
Open
mvanhorn wants to merge 1 commit intostdlib-js:developfrom
Open
chore: fix JavaScript lint errors (issue #11247)#11672mvanhorn wants to merge 1 commit intostdlib-js:developfrom
mvanhorn wants to merge 1 commit intostdlib-js:developfrom
Conversation
The @example block in `_tools/pkgs/entry-points/lib/sync.js` passes `/foo/bar/baz` (a non-existent path) to `entryPoints()`, which causes the function to throw synchronously while resolving the package path. The existing `// returns [{...}]` annotation therefore fails the `stdlib/jsdoc-doctest` check, which suggests a `// throws <Error>` annotation instead. Swap the annotation so the doctest matches the runtime behavior. Closes stdlib-js#11247
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.
Resolves #11247.
Description
This pull request:
Related Issues
This pull request has the following related issues:
Questions
No.
Other
The companion `async.js` in the same directory uses a similarly non-existent path (`./some/nonexistent/path`) but has no `// returns` / `// throws` annotation because results are delivered via callback, so doctest does not flag that variant and no change is needed there.
Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored with Claude Code. I reviewed the `stdlib/jsdoc-doctest` failure in the issue, confirmed the behavior manually (non-existent path causes `entryPoints()` to throw), and the model's suggested swap matches the linter's own hint.
@stdlib-js/reviewers