summaryrefslogtreecommitdiff
path: root/lib/elixir/lib/stream.ex
diff options
context:
space:
mode:
authorGal Tsubery <gal.tsubery@gmail.com>2017-03-21 13:28:02 -0500
committerJosé Valim <jose.valim@gmail.com>2017-03-21 19:28:02 +0100
commitb8b8e4cd62f80f5bb80bdf164ad28d149d969832 (patch)
tree294887932e7621579243363be1b930aedfc2b416 /lib/elixir/lib/stream.ex
parent99e44a181fb3440ef572be2f9592c94aa0a99ebc (diff)
downloadelixir-b8b8e4cd62f80f5bb80bdf164ad28d149d969832.tar.gz
Clarify starting value in scan/2 documentation (#5906)
Diffstat (limited to 'lib/elixir/lib/stream.ex')
-rw-r--r--lib/elixir/lib/stream.ex3
1 files changed, 2 insertions, 1 deletions
diff --git a/lib/elixir/lib/stream.ex b/lib/elixir/lib/stream.ex
index af04ae165..1ce550597 100644
--- a/lib/elixir/lib/stream.ex
+++ b/lib/elixir/lib/stream.ex
@@ -576,7 +576,8 @@ defmodule Stream do
@doc """
Creates a stream that applies the given function to each
element, emits the result and uses the same result as the accumulator
- for the next computation.
+ for the next computation. Uses the first element in the enumerable
+ as the starting value.
## Examples