aboutsummaryrefslogtreecommitdiffstats
path: root/repository.go
diff options
context:
space:
mode:
authorMáximo Cuadros <mcuadros@gmail.com>2018-07-16 11:33:02 +0200
committerGitHub <noreply@github.com>2018-07-16 11:33:02 +0200
commit9f00789688d26191a987fdec8bc2678362ec4453 (patch)
tree03668113d61f9ea50de8a6e9885d807eded3c249 /repository.go
parent5b1d5370c36994851da002f76ae7cbd3b7bc9221 (diff)
parent960fe7b668c7a0ebbd75f8898c95d5c4bdedf1f3 (diff)
downloadgo-git-9f00789688d26191a987fdec8bc2678362ec4453.tar.gz
Merge pull request #862 from thehowl/patch-1
git: fix documentation for Notes
Diffstat (limited to 'repository.go')
-rw-r--r--repository.go3
1 files changed, 2 insertions, 1 deletions
diff --git a/repository.go b/repository.go
index 717381b..680522c 100644
--- a/repository.go
+++ b/repository.go
@@ -872,7 +872,8 @@ func (r *Repository) Branches() (storer.ReferenceIter, error) {
}, refIter), nil
}
-// Notes returns all the References that are Branches.
+// Notes returns all the References that are notes. For more information:
+// https://git-scm.com/docs/git-notes
func (r *Repository) Notes() (storer.ReferenceIter, error) {
refIter, err := r.Storer.IterReferences()
if err != nil {