Add some docs

Author: entropidelic

core/connection.go

@@ -1,7 +1,6 @@
 package connection
 
 import (
-	"fmt"
 	"time"
 
 	"github.com/cenkalti/backoff/v4"
@@ -20,11 +19,15 @@ func (e PermanentError) Is(err error) bool {
 	return ok
 }
 
+// Retries a given function in an exponential backoff manner.
+// It will retry calling the function while it returns an error, until the max retries
+// from the configuration are reached, or until a `PermanentError` is returned.
+// The function to be retried should return `PermanentError` when the condition for stop retrying
+// is met.
 func Retry(functionToRetry func() (interface{}, error), minDelay uint64, factor float64, maxTries uint64) (interface{}, error) {
 	f := func() (interface{}, error) {
 		val, err := functionToRetry()
 		if perm, ok := err.(PermanentError); err != nil && ok {
-			fmt.Println("ENTRE")
 			return nil, backoff.Permanent(perm.Inner)
 		}
 		return val, err

core/connection_test.go

@@ -18,7 +18,7 @@ func DummyFunction(x uint64) (uint64, error) {
 }
 
 func TestRetry(t *testing.T) {
-	function := func() (interface{}, error) { return DummyFunction(42) }
+	function := func() (interface{}, error) { return DummyFunction(43) }
 	data, err := connection.Retry(function, 1000, 2, 3)
 	if err != nil {
 		t.Errorf("Retry error!: %s", err)