Update remote comments

Co-Authored-By: EmrysMyrddin <[email protected]>

Author: nlepage

_examples/ls-remote/main.go

@@ -8,7 +8,7 @@ import (
 	"gopkg.in/src-d/go-git.v4/storage/memory"
 )
 
-// Retreive remote tags without cloning repository
+// Retrieve remote tags without cloning repository
 func main() {
 
 	// Create the remote with repository URL
@@ -19,13 +19,13 @@ func main() {
 
 	log.Print("Fetching tags...")
 
-	// We can then use every Remote functions to retreive wanted informations
+	// We can then use every Remote functions to retrieve wanted informations
 	refs, err := rem.List(&git.ListOptions{})
 	if err != nil {
 		log.Fatal(err)
 	}
 
-	// Filters the reference list and only keep tags
+	// Filters the references list and only keeps tags
 	var tags []string
 	for _, ref := range refs {
 		if ref.Name().IsTag() {

remote.go

@@ -45,6 +45,9 @@ type Remote struct {
 	s storage.Storer
 }
 
+// NewRemote creates a new Remote.
+// The intended purpose is to use the Remote for tasks such as listing remote references (like using git ls-remote).
+// Otherwise Remotes should be created via the use of a Repository.
 func NewRemote(s storage.Storer, c *config.RemoteConfig) *Remote {
 	return &Remote{s: s, c: c}
 }