package documentation

Author: mcuadros

blame.go

@@ -1,11 +1,3 @@
-// Package blame contains blaming functionality for files in the repo.
-//
-// Blaming a file is finding what commit was the last to modify each of
-// the lines in the file, therefore the output of a blaming operation is
-// usualy a slice of commits, one commit per line in the file.
-//
-// This package also provides a pretty print function to output the
-// results of a blame in a similar format to the git-blame command.
 package git
 
 import (

doc.go

@@ -4,4 +4,31 @@
 //
 // We have been following the open/close principle in its design to facilitate
 // 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)
+//    }
+//
+//    if err := r.Pull("origin", "refs/heads/master"); err != nil {
+//    	panic(err)
+//    }
+//
+//    iter := r.Commits()
+//    defer iter.Close()
+//
+//    for {
+//    	commit, err := iter.Next()
+//    	if err != nil {
+//    		if err == io.EOF {
+//    			break
+//    		}
+//
+//    		panic(err)
+//    	}
+//
+//    	fmt.Println(commit)
+//  }
 package git