From 891fcfb419831c2ee5ca96c8f91bd35f0f3a3f58 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A1ximo=20Cuadros?= Date: Tue, 16 Oct 2018 11:18:27 +0200 Subject: [PATCH] repository: improve CheckoutOption.Hash doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Máximo Cuadros --- options.go | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/options.go b/options.go index b8bc1e979..5d10a88c3 100644 --- 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