Skip to content
This repository was archived by the owner on Sep 11, 2020. It is now read-only.

Commit cd64b4d

Browse files
authored
Merge pull request #985 from mcuadros/checkout-doc
repository: improve CheckoutOption.Hash doc
2 parents 07c03d9 + 891fcfb commit cd64b4d

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

options.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -231,8 +231,9 @@ var (
231231

232232
// CheckoutOptions describes how a checkout 31operation should be performed.
233233
type CheckoutOptions struct {
234-
// Hash to be checked out, if used HEAD will in detached mode. Branch and
235-
// Hash are mutually exclusive, if Create is not used.
234+
// Hash is the hash of the commit to be checked out. If used, HEAD will be
235+
// in detached mode. If Create is not used, Branch and Hash are mutually
236+
// exclusive.
236237
Hash plumbing.Hash
237238
// Branch to be checked out, if Branch and Hash are empty is set to `master`.
238239
Branch plumbing.ReferenceName

0 commit comments

Comments
 (0)