Fix doc regarding @async_with_timeout attribute

fertapric · Sep 10, 2017 · b1facf7 · b1facf7
1 parent 44f0e54
commit b1facf7
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.2.1
+
+### 1. Enhancements
+
+  * [async with] Correct documentation regarding `@async_with_timeout` attribute
+
 ## v0.2.0
 
 ### 1. Enhancements

diff --git a/lib/async_with.ex b/lib/async_with.ex
@@ -28,8 +28,9 @@ defmodule AsyncWith do
 
   ## Timeout attribute
 
-  The attribute `@async_with_timeout` can be used to configure the maximum time allowed per
-  clause. It expects a timeout in milliseconds, with the default value of `5000`.
+  The attribute `@async_with_timeout` can be used to configure the maximum time allowed to
+  execute all the clauses. It expects a timeout in milliseconds, with the default value of
+  `5000`.
 
       defmodule Acme do
         use AsyncWith