Merge pull request #22 from maxthomas/fix-docstring

Seth Ammons · web-flow · commit 99271bb5a99e · 2017-06-20T14:53:21.000-07:00
Rework docstring for LogHook.
diff --git a/main.go b/main.go
@@ -109,8 +109,8 @@ func NewExtendedClient(hc *http.Client) *Client {
 	return c
 }
 
-// PrintErrStrategy is used to log attempts as they happen.
-// You know, more visible
+// LogHook is used to log attempts as they happen. This function is never called,
+// however, if KeepLog is set to true.
 type LogHook func(e ErrEntry)
 
 // BackoffStrategy is used to determine how long a retry request should wait until attempted

Original file line number	Diff line number	Diff line change
`@@ -109,8 +109,8 @@ func NewExtendedClient(hc http.Client) Client {`
`109`	`109`	`return c`
`110`	`110`	`}`
`111`	`111`
`112`		`-// PrintErrStrategy is used to log attempts as they happen.`
`113`		`-// You know, more visible`
	`112`	`+// LogHook is used to log attempts as they happen. This function is never called,`
	`113`	`+// however, if KeepLog is set to true.`
`114`	`114`	`type LogHook func(e ErrEntry)`
`115`	`115`
`116`	`116`	`// BackoffStrategy is used to determine how long a retry request should wait until attempted`