From: nagachika00@...
Date: 2014-07-03T15:46:39+00:00
Subject: [ruby-core:63545] [ruby-trunk - Bug #9814] Improving documentation example for Enumerator#peek

Issue #9814 has been updated by Tomoyuki Chikanaga.

Backport changed from 2.0.0: REQUIRED, 2.1: REQUIRED to 2.0.0: REQUIRED, 2.1: DONE

Backported into `ruby_2_1` branch at r46677.

----------------------------------------
Bug #9814: Improving documentation example for Enumerator#peek
https://bugs.ruby-lang.org/issues/9814#change-47594

* Author: Erik Hollembeak
* Status: Closed
* Priority: Normal
* Assignee: Zachary Scott
* Category: doc
* Target version: current: 2.2.0
* ruby -v: ruby 2.1.1p76 (2014-02-24 revision 45161) [x86_64-darwin13.0]
* Backport: 2.0.0: REQUIRED, 2.1: DONE
----------------------------------------
The existing example for **Enumerator#peek** doesn't effectively document the behavior when peeking after an enumerator has been entirely consumed. Rather, it documents the behavior of **Enumerator#next**.

This change more effectively demonstrates that **StopIteration** is raised when peeking beyond the end of the enumerator.

---Files--------------------------------
0001-Improving-example-for-Enumerator-peek.patch (861 Bytes)


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