kotovalexarian-likes-github
/
docile
mirror of https://github.com/ms-ati/docile
1
0
Fork 0
Code Releases Activity

(documentation: fix misspelling and replace @yield with @param block)

This commit is contained in:
Marc Siegel 2013-08-02 15:45:12 -04:00
parent 9799c3a3af
commit 60f2489d4a
2 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
lib/docile.rb
View File

@ -36,7 +36,7 @@ module Docile
# #
# @param dsl [Object] context object whose methods make up the DSL # @param dsl [Object] context object whose methods make up the DSL
# @param args [Array] arguments to be passed to the block # @param args [Array] arguments to be passed to the block
# @yield the block of DSL commands to be executed against the # @param block [Proc] the block of DSL commands to be executed against the
# `dsl` context object # `dsl` context object
# @return [Object] the `dsl` context object after executing the block # @return [Object] the `dsl` context object after executing the block
def dsl_eval(dsl, *args, &block) def dsl_eval(dsl, *args, &block)
@ -74,7 +74,7 @@ module Docile
# @param dsl [Object] immutable context object whose methods make up the # @param dsl [Object] immutable context object whose methods make up the
# initial DSL # initial DSL
# @param args [Array] arguments to be passed to the block # @param args [Array] arguments to be passed to the block
# @yield the block of DSL commands to be executed against the # @param block [Proc] the block of DSL commands to be executed against the
# `dsl` context object and successor return values # `dsl` context object and successor return values
# @return [Object] the return value of the final command in the block # @return [Object] the return value of the final command in the block
def dsl_eval_immutable(dsl, *args, &block) def dsl_eval_immutable(dsl, *args, &block)

9
lib/docile/execution.rb
View File

@ -1,7 +1,7 @@
module Docile module Docile
# @api private # @api private
# #
# A namespace for functions relating to the execution of a block agsinst a # A namespace for functions relating to the execution of a block against a
# proxy object. # proxy object.
module Execution module Execution
# Execute a block in the context of an object whose methods represent the # Execute a block in the context of an object whose methods represent the
@ -9,11 +9,10 @@ module Docile
# #
# @param dsl [Object] context object whose methods make up the # @param dsl [Object] context object whose methods make up the
# (initial) DSL # (initial) DSL
# @param proxy_type [FallbackContextProxy, # @param proxy_type [FallbackContextProxy, ChainingFallbackContextProxy]
# ChainingFallbackContextProxy] # which class to instantiate as proxy context
# class to instantiate as the proxy context
# @param args [Array] arguments to be passed to the block # @param args [Array] arguments to be passed to the block
# @yield the block of DSL commands to be executed # @param block [Proc] the block of DSL commands to be executed
# @return [Object] the return value of the block # @return [Object] the return value of the block
def exec_in_proxy_context(dsl, proxy_type, *args, &block) def exec_in_proxy_context(dsl, proxy_type, *args, &block)
block_context = eval("self", block.binding) block_context = eval("self", block.binding)