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

repository: improve CheckoutOption.Hash doc#985

Merged
mcuadros merged 1 commit intosrc-d:masterfrom
mcuadros:checkout-doc
Oct 16, 2018
Merged

repository: improve CheckoutOption.Hash doc#985
mcuadros merged 1 commit intosrc-d:masterfrom
mcuadros:checkout-doc

Conversation

@mcuadros
Copy link
Copy Markdown
Contributor

The CheckoutOption.Hash can be used only with hash commits, this PR clarifies this on the documentation.

#954

@mcuadros mcuadros requested a review from smola October 15, 2018 12:56
Comment thread options.go Outdated
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
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 <mcuadros@gmail.com>
@mcuadros mcuadros merged commit cd64b4d into src-d:master Oct 16, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants