docs: fix two syntax errors in JSDoc @example blocks#2536
Merged
Conversation
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.
Problem
Two of the JSDoc
@examplesnippets inlib/command.jsare not valid JavaScript, so anyone copying them to try out the API hits a syntax error.commandsGroup()example (was missing the closing quote, unterminated string):helpOption()example (was missing the comma between the two arguments):Both throw when run as-is. Checking each snippet with
node --check:Solution
Add the missing closing quote and the missing comma so both examples match the documented signatures and parse cleanly:
After the change, each snippet passes
node --check, andnpm test(lint, unit tests, and type checks) is green.ChangeLog
Fixed two invalid JavaScript snippets in the JSDoc examples for
.commandsGroup()and.helpOption().