Merge pull request #1930 from jwarwick/stream_docs

Cleaning up Stream docs

Author: José Valim

lib/elixir/lib/stream.ex

@@ -76,7 +76,7 @@ defmodule Stream do
   There are many functions in Elixir's standard library that return
   streams, some examples are:
 
-  * `IO.stream/1` - Streams input lines, one by one;
+  * `IO.stream/2` - Streams input lines, one by one;
   * `URI.query_decoder/1` - Decodes a query string, pair by pair;
 
   This module also provides many convenience functions for creating streams,
@@ -209,7 +209,7 @@ defmodule Stream do
   from `pad` if it was passed. If `pad` is passed and does not
   have enough elements to fill the chunk, then the chunk is
   returned anyway with less than `n` elements. If `pad` is not
-  passed at all or is nil, then the partial chunk is discarded
+  passed at all or is `nil`, then the partial chunk is discarded
   from the result.
 
   ## Examples
@@ -245,7 +245,7 @@ defmodule Stream do
   @doc """
   Chunks the `enum` by buffering elements for which `fun` returns
   the same value and only emit them when `fun` returns a new value
-  or the `enum` finishes,
+  or the `enum` finishes.
 
   ## Examples
 
@@ -319,7 +319,7 @@ defmodule Stream do
 
   @doc """
   Lazily drops elements of the enumerable while the given
-  function returns true.
+  function returns `true`.
 
   ## Examples
 
@@ -377,10 +377,10 @@ defmodule Stream do
   end
 
   @doc """
-  Creates a stream that filters and then map elements according
-  to given funtions.
+  Creates a stream that filters and then maps elements according
+  to given functions.
 
-  It exists for simmetry with Enum.filter_map/3.
+  Exists for symmetry with `Enum.filter_map/3`.
 
   ## Examples
 
@@ -412,7 +412,7 @@ defmodule Stream do
 
   @doc """
   Creates a stream that applies the given function to each
-  element, emits the result and uses the same result as accumulator
+  element, emits the result and uses the same result as the accumulator
   for the next computation.
 
   ## Examples
@@ -429,8 +429,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 accumulator
-  for the next computation. Uses the given `acc` as starting value.
+  element, emits the result and uses the same result as the accumulator
+  for the next computation. Uses the given `acc` as the starting value.
 
   ## Examples
 
@@ -527,7 +527,7 @@ defmodule Stream do
 
   ## Examples
 
-  Open up a file, replace all # by % and stream to another file
+  Open up a file, replace all `#` by `%` and stream to another file
   without loading the whole file in memory:
 
       stream = File.stream!("code")
@@ -551,7 +551,7 @@ defmodule Stream do
   For such, the collection is fully enumerated keeping up to `2 * n`
   elements in memory. Once the end of the collection is reached,
   the last `count` elements will be executed. Therefore, using
-  a negative `n` in an infinite collection will never return.
+  a negative `n` on an infinite collection will never return.
 
   ## Examples
 
@@ -607,7 +607,7 @@ defmodule Stream do
   @doc """
   Creates a stream that takes every `n` item from the enumerable.
 
-  The first item is always included, unless n is 0.
+  The first item is always included, unless `n` is 0.
 
   ## Examples
 
@@ -625,7 +625,7 @@ defmodule Stream do
 
   @doc """
   Lazily takes elements of the enumerable while the given
-  function returns true.
+  function returns `true`.
 
   ## Examples
 
@@ -640,10 +640,10 @@ defmodule Stream do
   end
 
   @doc """
-  Creates a stream that only emits elements if they are uniq.
+  Creates a stream that only emits elements if they are unique.
 
   Keep in mind that, in order to know if an element is unique
-  or not, this function needs to store all uniq values emitted
+  or not, this function needs to store all unique values emitted
   by the stream. Therefore, if the stream is infinite, the number
   of items stored will grow infinitely, never being garbage collected.
 
@@ -664,7 +664,7 @@ defmodule Stream do
 
   @doc """
   Creates a stream where each item in the enumerable will
-  be accompanied by its index.
+  be wrapped in a tuple alongside its index.
 
   ## Examples
 
@@ -885,7 +885,7 @@ defmodule Stream do
   Successive values are generated by calling `next_fun` with the
   previous accumulator (the initial value being the result returned
   by `start_fun`) and it must return a tuple with the current and
-  next accumulator. The enumeration finishes if it returns nil.
+  next accumulator. The enumeration finishes if it returns `nil`.
 
   As the name says, this function is useful to stream values from
   resources.
@@ -940,7 +940,7 @@ defmodule Stream do
 
   Successive values are generated by calling `next_fun` with the previous
   accumulator and it must return a tuple with the current and next
-  accumulator. The enumeration finishes if it returns nil.
+  accumulator. The enumeration finishes if it returns `nil`.
 
   ## Examples