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

feat(): add examples #1682

Merged
merged 8 commits into from Jun 30, 2020
Merged

feat(): add examples #1682

merged 8 commits into from Jun 30, 2020

Conversation

rluvaton
Copy link
Contributor

@rluvaton rluvaton commented Jun 28, 2020

add function to add multiple examples at once

#1683

@bcoe
Copy link
Member

bcoe commented Jun 29, 2020

I like this idea 👍 I think I would rather we overrode example to accept a string or string[] rather than adding the new .examples() though -- there are already several methods that accept both the singular and array form.

Thank you for the contribution.

as @bcoe [suggested](#1682 (comment))
merge the functions to one that either accepts an array or 2 strings
@rluvaton
Copy link
Contributor Author

rluvaton commented Jun 29, 2020

I like this idea 👍 I think I would rather we overrode example to accept a string or string[] rather than adding the new .examples() though -- there are already several methods that accept both the singular and array form.

Thank you for the contribution.

@bcoe Fixed it in the latest commit
(GitHub has systemwide issue and the support team told me that the PR will update in a few hours 😬)

@rluvaton
Copy link
Contributor Author

@bcoe I recommend you would squash this PR (it contain lots oh I forgot something commit 😬)

docs/api.md Outdated Show resolved Hide resolved
@bcoe
Copy link
Member

bcoe commented Jun 29, 2020

I recommend you would squash this PR (it contain lots oh I forgot something commit 😬)

@rluvaton no worries, we always squash 😄

Update the header as requested in the review
@bcoe bcoe merged commit 225ab82 into yargs:master Jun 30, 2020
@bcoe
Copy link
Member

bcoe commented Jun 30, 2020

@rluvaton thank you for the contribution.

@rluvaton rluvaton deleted the patch-1 branch June 30, 2020 08:19
@rluvaton
Copy link
Contributor Author

@bcoe when this feature should be release?

@bcoe
Copy link
Member

bcoe commented Jul 1, 2020

@rluvaton if you have a few moments, mind testing out a pre-release of this feature:

npm i yargs@15.4.0-beta.1

I'll release soon if things are looking good.

@rluvaton
Copy link
Contributor Author

rluvaton commented Jul 1, 2020

@rluvaton if you have a few moments, mind testing out a pre-release of this feature:

npm i yargs@15.4.0-beta.1

I'll release soon if things are looking good.

I tried it and it looks good so far (except the missing type definition for the new feature [obviously])

@bcoe
Copy link
Member

bcoe commented Jul 2, 2020

@rluvaton okay, yargs@15.4.0 is actually released.

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.

None yet

2 participants