improve documentation and use golint notes

Author: Jan Seidl

retry.go

@@ -3,16 +3,16 @@
 package retry
 
 import (
-	"errors"
 	"fmt"
 	"time"
 )
 
+// Function signature of retryable function
 type Retryable func() error
-type OnRetry func(n uint, err error)
 
-var defaultTries uint = 10
-var defaultDelay time.Duration = 1e5
+// Function signature of OnRetry function
+// n = count of tries
+type OnRetry func(n uint, err error)
 
 // Retry - simple retry
 //
@@ -47,7 +47,7 @@ func RetryWithOpts(retryableFunction Retryable, opts RetryOpts) error {
 // is possible set OnRetry function callback
 // which are called each retry
 func RetryCustom(retryableFunction Retryable, onRetryFunction OnRetry, opts RetryOpts) error {
-	var n uint = 0
+	var n uint
 
 	for n < opts.tries {
 		err := retryableFunction()
@@ -64,5 +64,5 @@ func RetryCustom(retryableFunction Retryable, onRetryFunction OnRetry, opts Retr
 		n++
 	}
 
-	return errors.New(fmt.Sprintf("All (%d) retries fail", opts.tries))
+	return fmt.Errorf("All (%d) retries fail", opts.tries)
 }

retry_test.go

@@ -8,7 +8,7 @@ import (
 )
 
 func TestCustom(t *testing.T) {
-	var retrySum uint = 0
+	var retrySum uint
 	err := RetryCustom(
 		func() error { return errors.New("test") },
 		func(n uint, err error) { retrySum += n },

retryopts.go

@@ -4,26 +4,40 @@ import (
 	"time"
 )
 
+// Struct for configure retry
+// tries - count of tries
+// delay - waiting time
+// units - waiting time unit (for tests purpose)
 type RetryOpts struct {
 	tries uint
 	delay time.Duration
 	units time.Duration
 }
 
+var defaultTries uint = 10
+var defaultDelay time.Duration = 1e5
+
+// Create new RetryOpts struct with default values
+// default tries are 10
+// default delay are 1e5
+// default units are microsecond
 func NewRetryOpts() RetryOpts {
 	return RetryOpts{tries: defaultTries, delay: defaultDelay, units: time.Microsecond}
 }
 
+// Units setter
 func (opts RetryOpts) Units(timeUnit time.Duration) RetryOpts {
 	opts.units = timeUnit
 	return opts
 }
 
+// Delay setter
 func (opts RetryOpts) Delay(delay time.Duration) RetryOpts {
 	opts.delay = delay
 	return opts
 }
 
+// Tries setter
 func (opts RetryOpts) Tries(tries uint) RetryOpts {
 	opts.tries = tries
 	return opts