This repository has been archived by the owner on Sep 11, 2020. It is now read-only.
repository: improve CheckoutOption.Hash doc #985
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
smola
reviewed
Oct 16, 2018
options.go
Outdated
| @@ -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 in | |||
There was a problem hiding this comment.
Maybe rephrase a little bit:
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.
Signed-off-by: Máximo Cuadros <[email protected]>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
CheckoutOption.Hashcan be used only with hash commits, this PR clarifies this on the documentation.#954