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 <[email protected]>
patrickdevivo · Jun 16, 2018 · 960fe7b · 960fe7b
1 parent 0710c6c
commit 960fe7b
Showing 1 changed file with 2 additions and 1 deletion.
diff --git 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 {