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.

Sign up for GitHub

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

Jump to bottom

Readme: checkout language #869

Closed

skvale opened this issue Dec 1, 2022 · 1 comment

skvale commented Dec 1, 2022 •

edited

The readme says

.checkout(options) - uses the checks out the supplied options object/array to check out.

git-js/simple-git/readme.md

Line 239 in 459ec92

    
           -  `.checkout(options)` - uses the checks out the supplied [options](#how-to-specify-options) object/array to check out.

That wording feels a bit off, how about:

.checkout(options) - check out a tag or revision using the supplied name or [options](https://github.com/steveukx/git-js#how-to-specify-options)

The text was updated successfully, but these errors were encountered:

steveukx closed this as completed in

edfd459

Owner

steveukx commented Dec 8, 2022

Thanks for the suggestion, this will be released with the next version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment