From 7a834c17c3ed690a6f3b40cbc3b75cb04926c210 Mon Sep 17 00:00:00 2001 From: Roland Date: Fri, 2 Sep 2011 08:47:28 +0200 Subject: [PATCH] improve wording of doc for Future.await(atMost), fixes #1158 --- akka-actor/src/main/scala/akka/dispatch/Future.scala | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/akka-actor/src/main/scala/akka/dispatch/Future.scala b/akka-actor/src/main/scala/akka/dispatch/Future.scala index bd1d9c4fb1..834cf60f45 100644 --- a/akka-actor/src/main/scala/akka/dispatch/Future.scala +++ b/akka-actor/src/main/scala/akka/dispatch/Future.scala @@ -397,9 +397,12 @@ sealed trait Future[+T] extends japi.Future[T] { /** * Blocks the current thread until the Future has been completed or the - * timeout has expired. The timeout will be the least value of 'atMost' and the timeout - * supplied at the constructuion of this Future. - * In the case of the timeout expiring a FutureTimeoutException will be thrown. + * timeout has expired, additionally bounding the waiting period according to + * the atMost parameter. The timeout will be the lesser value of + * 'atMost' and the timeout supplied at the constructuion of this Future. In + * the case of the timeout expiring a FutureTimeoutException will be thrown. + * Other callers of this method are not affected by the additional bound + * imposed by atMost. */ def await(atMost: Duration): Future[T]