(documentation: fix misspelling and replace @yield with @param block)
This commit is contained in:
parent
9799c3a3af
commit
60f2489d4a
|
@ -36,7 +36,7 @@ module Docile
|
|||
#
|
||||
# @param dsl [Object] context object whose methods make up the DSL
|
||||
# @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
|
||||
# @return [Object] the `dsl` context object after executing the block
|
||||
def dsl_eval(dsl, *args, &block)
|
||||
|
@ -74,7 +74,7 @@ module Docile
|
|||
# @param dsl [Object] immutable context object whose methods make up the
|
||||
# initial DSL
|
||||
# @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
|
||||
# @return [Object] the return value of the final command in the block
|
||||
def dsl_eval_immutable(dsl, *args, &block)
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
module Docile
|
||||
# @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.
|
||||
module Execution
|
||||
# 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
|
||||
# (initial) DSL
|
||||
# @param proxy_type [FallbackContextProxy,
|
||||
# ChainingFallbackContextProxy]
|
||||
# class to instantiate as the proxy context
|
||||
# @param proxy_type [FallbackContextProxy, ChainingFallbackContextProxy]
|
||||
# which class to instantiate as proxy context
|
||||
# @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
|
||||
def exec_in_proxy_context(dsl, proxy_type, *args, &block)
|
||||
block_context = eval("self", block.binding)
|
||||
|
|
Loading…
Reference in New Issue