add godoc comment to NewDriver

tejasmanohar · tejasmanohar · commit 18d51f37a137 · 2017-12-29T09:46:50.000-06:00
diff --git a/driver.go b/driver.go
@@ -23,6 +23,11 @@ type Driver struct {
 	cfg *Config
 }
 
+// NewDriver allows you to register your own driver with `sql.Register`.
+// It's useful for more complex use cases. Read more in PR #3.
+// https://github.com/segmentio/go-athena/pull/3
+//
+// Generally, sql.Open() or athena.Open() should suffice.
 func NewDriver(cfg *Config) *Driver {
 	return &Driver{cfg}
 }

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,11 @@ type Driver struct {`
`23`	`23`	`cfg *Config`
`24`	`24`	`}`
`25`	`25`
	`26`	+// NewDriver allows you to register your own driver with `sql.Register`.
	`27`	`+// It's useful for more complex use cases. Read more in PR #3.`
	`28`	`+// https://github.com/segmentio/go-athena/pull/3`
	`29`	`+//`
	`30`	`+// Generally, sql.Open() or athena.Open() should suffice.`
`26`	`31`	`func NewDriver(cfg Config) Driver {`
`27`	`32`	`return &Driver{cfg}`
`28`	`33`	`}`