summaryrefslogtreecommitdiff
path: root/lib/elixir/lib/stream.ex
diff options
context:
space:
mode:
authorEksperimental <eksperimental@users.noreply.github.com>2016-07-10 16:14:47 +0700
committerJosé Valim <jose.valim@gmail.com>2016-07-10 11:14:47 +0200
commit2f760205c66d95f961153201b60990d8f3ad28b6 (patch)
tree2a5553f7aa10cf5575f6fa38c7119affb76f03b5 /lib/elixir/lib/stream.ex
parentfb2ef08b22b62c7799c0be1a0aef916779a9c922 (diff)
downloadelixir-2f760205c66d95f961153201b60990d8f3ad28b6.tar.gz
Mention offset arg. in Enum.with_index/2 and Stream.with_index/2 docs (#4985)
Diffstat (limited to 'lib/elixir/lib/stream.ex')
-rw-r--r--lib/elixir/lib/stream.ex2
1 files changed, 2 insertions, 0 deletions
diff --git a/lib/elixir/lib/stream.ex b/lib/elixir/lib/stream.ex
index 9acd39822..12bb616fd 100644
--- a/lib/elixir/lib/stream.ex
+++ b/lib/elixir/lib/stream.ex
@@ -879,6 +879,8 @@ defmodule Stream do
Creates a stream where each item in the enumerable will
be wrapped in a tuple alongside its index.
+ If an `offset` is given, we will index from the given offset instead of from zero.
+
## Examples
iex> stream = Stream.with_index([1, 2, 3])