Bug #8392

stdlib's 'forwardable' documentation has a bad example

Added by Joe Miragliuolo 12 months ago. Updated 11 months ago.

[ruby-core:54920]
Status:Closed
Priority:Normal
Assignee:Zachary Scott
Category:doc
Target version:2.1.0
ruby -v:ruby 2.0.0p0 (2013-02-24 revision 39474) [x86_64-darwin11.4.2] Backport:1.9.3: UNKNOWN, 2.0.0: UNKNOWN

Description

=begin
As this is a problem with the documentation, there are no steps required to reproduce it.
My Ruby version is currently ruby 2.0.0p0 (2013-02-24 revision 39474) [x8664-darwin11.4.2], but this documentation problem appears to have been in Ruby since at least ruby 1.9.3p194 (2012-04-20 revision 35410) [x8664-darwin11.4.0].

Problem:
The second example of the (({Forwardable})) module in stdlib appears to be a mish-mash of two separate and incompatible examples. It begins by defining deligators for a (({RecordCollection})) class, but then goes on to make a new instance of the (({Foo})) class (never defined), calling methods on that instance that are also never defined.

Expected:
I expected it to show a new instance of the (({RecordCollection})) class and to call the methods that were delegated in the first parts of the example ((({:record_number, :size, :<<, :map}))).

=end

Associated revisions

Revision 40839
Added by Zachary Scott 11 months ago

  • lib/forwardable.rb: Forwardable examples in overview were broken Based on patch by @joem [Fixes GH-303] [Bug #8392]

History

#1 Updated by Zachary Scott 12 months ago

  • Category set to doc
  • Status changed from Open to Assigned
  • Assignee set to Zachary Scott
  • Target version set to 2.1.0

#2 Updated by Zachary Scott 12 months ago

I have left some comments on the pull request, please check it.

#3 Updated by Zachary Scott 11 months ago

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

This issue was solved with changeset r40839.
Joe, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.


  • lib/forwardable.rb: Forwardable examples in overview were broken Based on patch by @joem [Fixes GH-303] [Bug #8392]

Also available in: Atom PDF