Skip to content

Commit

Permalink
add godoc comment to NewDriver
Browse files Browse the repository at this point in the history
  • Loading branch information
tejasmanohar committed Dec 29, 2017
1 parent 66c80a7 commit 18d51f3
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions driver.go
Original file line number Diff line number Diff line change
Expand Up @@ -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}
}
Expand Down

0 comments on commit 18d51f3

Please sign in to comment.