Skip to content

Fix doc for using SingleForwardable with Module #231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
vandrijevik wants to merge 1 commit into from
Closed

Fix doc for using SingleForwardable with Module #231

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Fix doc for using SingleForwardable with Module 
The example for using SingleForwardable with
a Class or Module was incorrect Ruby (it
resulted in an exception).

Since the English sentence was not clear
about what the example was trying to document,
this is my best guess. The new example
illustrates that a Module can be delegated from
by extending it with SingleForwardable and
using `def_delegator`.
  • Loading branch information
Vladimir Andrijevik committed Jan 2, 2013
commit 33ba59a320776635635835d8c4f75bc68a0129b8
22 changes: 13 additions & 9 deletions lib/forwardable.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,17 +196,21 @@ def #{ali}(*args, &block)
# printer.def_delegator "STDOUT", "puts" # add delegation for STDOUT.puts()
# printer.puts "Howdy!"
#
# Also, SingleForwardable can be use to Class or Module.
# Also, SingleForwardable can be used to set up delegation for a Class or Module.
#
# module Facade
# extend SingleForwardable
# def_delegator :Implementation, :service
#
# class Implementation
# def service...
# end
# end
# class Implementation
# def self.service
# puts "serviced!"
# end
# end
#
# module Facade
# extend SingleForwardable
# def_delegator :Implementation, :service
# end
#
# Facade.service #=> serviced!
#
# If you want to use both Forwardable and SingleForwardable, you can
# use methods def_instance_delegator and def_single_delegator, etc.
module SingleForwardable
Expand Down