From 60b735ee36112f7464c054a26934f5cbedb40481 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=ABl=20G=C3=A4hwiler?= Date: Sat, 28 Dec 2019 12:22:35 +0100 Subject: [PATCH] fmt --- client/futures.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/client/futures.go b/client/futures.go index 416082e..c16e2a5 100644 --- a/client/futures.go +++ b/client/futures.go @@ -9,10 +9,10 @@ import ( // A GenericFuture is returned by publish and unsubscribe methods. type GenericFuture interface { - // Wait will block until the future is completed or canceled. It will return - // future.ErrCanceled if the future gets canceled. If the timeout is reached, - // future.ErrTimeoutExceeded is returned. - // + // Wait will wait the given amount of time and return whether the future has + // been completed, canceled or the request timed out. If no time has been + // provided the wait will never timeout. + // Note: Wait will not return any Client related errors. Wait(timeout time.Duration) error }