Merge pull request #293 from ajnavarro/improvement/examples

_examples: improve documentation (fix #238)

1 files changed, 3 insertions, 0 deletions

diff --git a/_examples/push/main.go b/_examples/push/main.go
index aaec5a3..809c26b 100644
--- a/_examples/push/main.go
+++ b/_examples/push/main.go
@@ -7,6 +7,8 @@ import (
 	. "srcd.works/go-git.v4/_examples"
 )
 
+// Example of how to open a repository in a specific path, and push to
+// its default remote (origin).
 func main() {
 	CheckArgs("<repository-path>")
 	path := os.Args[1]
@@ -15,6 +17,7 @@ func main() {
 	CheckIfError(err)
 
 	Info("git push")
+	// push using default options
 	err = r.Push(&git.PushOptions{})
 	CheckIfError(err)
 }