From 960fe7b668c7a0ebbd75f8898c95d5c4bdedf1f3 Mon Sep 17 00:00:00 2001 From: Morgan Date: Wed, 13 Jun 2018 10:19:36 +0200 Subject: Fix documentation for Notes It previously said that it returned all references that are branches, but that's not true. Signed-off-by: Morgan Bazalgette --- repository.go | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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 { -- cgit