From: jared@...
Date: 2014-11-03T06:51:09+00:00
Subject: [ruby-core:66063] [ruby-trunk - misc #10469] [Open] Documented return value for Array#each

Issue #10469 has been reported by Jared Beck.

----------------------------------------
misc #10469: Documented return value for Array#each
https://bugs.ruby-lang.org/issues/10469

* Author: Jared Beck
* Status: Open
* Priority: Low
* Assignee: Zachary Scott
* Category: doc
* Target version: next minor
----------------------------------------
This is a minor documentation suggestion.

When given a block, `Array#each` returns `self`.

    [1,2,3].each { |x| 'banana' }
    #=> [1, 2, 3]

However, this is not obvious (to me) from the documentation.

The documented method signature is `each { |item| block } ��� ary`.  Perhaps most people would understand that `ary` is `self`, but I think it could be more clear.

Perhaps something like the following (change in bold):

Calls the given block once for each element in self, passing that element as a parameter, **and returning the array itself.**

Thanks!



-- 
https://bugs.ruby-lang.org/