Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: missing return in usage builder function #2328

Merged
merged 1 commit into from May 1, 2023

Conversation

shadowspawn
Copy link
Member

A Typescript error was reported which was due to a missing return in a builder function for a .usage() call based on the example code. I did not do a deep dive into whether the TypeScript was correct, but the main builder function example has a return so it seemed pretty likely the return is expected for usage too.

Closes: #2321

@bcoe bcoe merged commit e517318 into yargs:main May 1, 2023
7 checks passed
@shadowspawn shadowspawn deleted the doc-missing-return branch January 4, 2024 21:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Usage command builder function incorrectly documented
2 participants