godoc

brentp · brentp · commit a57e5bcd3a72 · 2016-04-15T15:27:30.000-06:00
diff --git a/genomefile.go b/genomefile.go
@@ -10,6 +10,7 @@ import (
 	"github.com/brentp/xopen"
 )
 
+// GenomeFile has the Lengths and Orders of the chromosomes.
 type GenomeFile struct {
 	Lengths map[string]int
 	Order   map[string]int
@@ -21,6 +22,7 @@ func (g *GenomeFile) Less(a, b string) bool {
 	return g.Order[a] <= g.Order[b]
 }
 
+// ReadGenomeFile returns a GenomeFile struct
 func ReadGenomeFile(path string) (*GenomeFile, error) {
 
 	rdr, err := xopen.Ropen(path)

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@ import (`
`10`	`10`	`"github.com/brentp/xopen"`
`11`	`11`	`)`
`12`	`12`
	`13`	`+// GenomeFile has the Lengths and Orders of the chromosomes.`
`13`	`14`	`type GenomeFile struct {`
`14`	`15`	`Lengths map[string]int`
`15`	`16`	`Order map[string]int`
`@@ -21,6 +22,7 @@ func (g *GenomeFile) Less(a, b string) bool {`
`21`	`22`	`return g.Order[a] <= g.Order[b]`
`22`	`23`	`}`
`23`	`24`
	`25`	`+// ReadGenomeFile returns a GenomeFile struct`
`24`	`26`	`func ReadGenomeFile(path string) (*GenomeFile, error) {`
`25`	`27`
`26`	`28`	`rdr, err := xopen.Ropen(path)`