Misc #10469: Documented return value for Array#each

• Status: Closed
• Assignee: zzak (zzak _)

[jaredbeck (Jared Beck)]

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!

[jaredbeck (Jared Beck)]

• File array_each_return_docs.patch array_each_return_docs.patch added

Here's a patch, if that helps.

[hsbt (Hiroshi SHIBATA)]

• Status changed from Open to Closed