aboutsummaryrefslogtreecommitdiffstats
path: root/doc.go
diff options
context:
space:
mode:
authorweirdgiraffe <giraffe@cyberzoo.xyz>2016-11-03 15:43:06 +0100
committerMáximo Cuadros <mcuadros@gmail.com>2016-11-03 15:43:06 +0100
commit94f5e9c949963893d1c3d3e987a591ee15265327 (patch)
tree12e1da541f64466c8185bb9e7f99dda184195824 /doc.go
parent1918bfe458729488e4a656cbbef7a2430e7ec2f5 (diff)
downloadgo-git-94f5e9c949963893d1c3d3e987a591ee15265327.tar.gz
fix package documentation (#109)
update example code to actual go-git.v4
Diffstat (limited to 'doc.go')
-rw-r--r--doc.go45
1 files changed, 23 insertions, 22 deletions
diff --git a/doc.go b/doc.go
index e9d51c2..8d00689 100644
--- a/doc.go
+++ b/doc.go
@@ -6,30 +6,31 @@
// extensions.
//
// Small example extracting the commits from a repository:
-// func ExampleBasic_printCommits() {
-// r, err := git.NewRepository("https://github.com/src-d/go-git", nil)
-// if err != nil {
-// panic(err)
-// }
+// func ExampleBasic_printCommits() {
+// r := git.NewMemoryRepository()
+// o := &git.CloneOptions{
+// URL: "https://github.com/src-d/go-git",
+// }
+// if err := r.Clone(o); err != nil {
+// panic(err)
+// }
//
-// if err := r.Pull("origin", "refs/heads/master"); err != nil {
-// panic(err)
-// }
+// iter, err := r.Commits()
+// if err != nil {
+// panic(err)
+// }
+// defer iter.Close()
//
-// iter := r.Commits()
-// defer iter.Close()
+// for {
+// commit, err := iter.Next()
+// if err != nil {
+// if err == io.EOF {
+// break
+// }
+// panic(err)
+// }
//
-// for {
-// commit, err := iter.Next()
-// if err != nil {
-// if err == io.EOF {
-// break
-// }
-//
-// panic(err)
-// }
-//
-// fmt.Println(commit)
-// }
+// fmt.Println(commit)
// }
+// }
package git // import "gopkg.in/src-d/go-git.v4"