Bug #9814: Improving documentation example for Enumerator#peek

• Status: Closed
• Assignee: zzak (zzak _)
• Target version: 2.2.0
• ruby -v: ruby 2.1.1p76 (2014-02-24 revision 45161) [x86_64-darwin13.0]
• Backport: 2.0.0: DONE, 2.1: DONE

[futureperfect (Erik Hollembeak)]

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.

[zzak (zzak _)]

• Status changed from Open to Assigned
• Assignee changed from drbrain (Eric Hodel) to zzak (zzak _)

[zzak (zzak _)]

• Status changed from Assigned to Closed
• % Done changed from 0 to 100

Applied in changeset r46099.

---

• enumerator.c: [DOC] Fix example to show Enumerator#peek behavior
  Patch by Erik Hollembeak [Bug #9814] [ci skip]

[usa (Usaku NAKAMURA)]

• Backport changed from 2.0.0: UNKNOWN, 2.1: UNKNOWN to 2.0.0: REQUIRED, 2.1: REQUIRED

[nagachika (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.

[usa (Usaku NAKAMURA)]

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

backported into ruby_2_0_0 at r46745.