Fix documentation for Notes

thehowl · thehowl · commit 960fe7b668c7 · 2018-06-16T12:49:57.000+02:00
It previously said that it returned all references that are branches, but that's not true.

Signed-off-by: Morgan Bazalgette &lt;the@howl.moe&gt;
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 {

Original file line number	Diff line number	Diff line change
`@@ -872,7 +872,8 @@ func (r *Repository) Branches() (storer.ReferenceIter, error) {`
`872`	`872`	`}, refIter), nil`
`873`	`873`	`}`
`874`	`874`
`875`		`-// Notes returns all the References that are Branches.`
	`875`	`+// Notes returns all the References that are notes. For more information:`
	`876`	`+// https://git-scm.com/docs/git-notes`
`876`	`877`	`func (r *Repository) Notes() (storer.ReferenceIter, error) {`
`877`	`878`	`refIter, err := r.Storer.IterReferences()`
`878`	`879`	`if err != nil {`