Merge pull request #966 from aymanbagabas/taghash-checkout

git: worktree checkout tag hash id (#959)

1 files changed, 3 insertions, 3 deletions

diff --git a/options.go b/options.go
index 8902b7e..e748b91 100644
--- a/options.go
+++ b/options.go
@@ -324,9 +324,9 @@ var (
 
 // CheckoutOptions describes how a checkout operation should be performed.
 type CheckoutOptions struct {
-	// Hash is the hash of the commit to be checked out. If used, HEAD will be
-	// in detached mode. If Create is not used, Branch and Hash are mutually
-	// exclusive.
+	// Hash is the hash of a commit or tag to be checked out. If used, HEAD
+	// will be in detached mode. If Create is not used, Branch and Hash are
+	// mutually exclusive.
 	Hash plumbing.Hash
 	// Branch to be checked out, if Branch and Hash are empty is set to `master`.
 	Branch plumbing.ReferenceName