Merge pull request #13 from CodeLingoBot/rewrite

jehiah · web-flow · commit 2ce732934e16 · 2019-12-24T14:28:09.000-05:00
Fix function comments based on best practices from Effective Go
diff --git a/hostpool.go b/hostpool.go
@@ -9,7 +9,7 @@ import (
 	"time"
 )
 
-// Returns current version
+// Version returns current version
 func Version() string {
 	return "0.1"
 }
@@ -110,7 +110,7 @@ func doMark(err error, r HostPoolResponse) {
 	}
 }
 
-// return an entry from the HostPool
+// Get returns an entry from the HostPool
 func (p *standardHostPool) Get() HostPoolResponse {
 	p.Lock()
 	defer p.Unlock()

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ import (`
`9`	`9`	`"time"`
`10`	`10`	`)`
`11`	`11`
`12`		`-// Returns current version`
	`12`	`+// Version returns current version`
`13`	`13`	`func Version() string {`
`14`	`14`	`return "0.1"`
`15`	`15`	`}`
`@@ -110,7 +110,7 @@ func doMark(err error, r HostPoolResponse) {`
`110`	`110`	`}`
`111`	`111`	`}`
`112`	`112`
`113`		`-// return an entry from the HostPool`
	`113`	`+// Get returns an entry from the HostPool`
`114`	`114`	`func (p *standardHostPool) Get() HostPoolResponse {`
`115`	`115`	`p.Lock()`
`116`	`116`	`defer p.Unlock()`