Merge pull request src-d#985 from mcuadros/checkout-doc

repository: improve CheckoutOption.Hash doc
fkorotkov · Oct 16, 2018 · cd64b4d · cd64b4d
2 parents 07c03d9 + 891fcfb
commit cd64b4d
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/options.go b/options.go
@@ -231,8 +231,9 @@ var (
 
 // CheckoutOptions describes how a checkout 31operation should be performed.
 type CheckoutOptions struct {
-	// Hash to be checked out, if used HEAD will in detached mode. Branch and
-	// Hash are mutually exclusive, if Create is not used.
+	// 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 plumbing.Hash
 	// Branch to be checked out, if Branch and Hash are empty is set to `master`.
 	Branch plumbing.ReferenceName