From 60f2489d4a74f0092c505643cc62ffd85249d4da Mon Sep 17 00:00:00 2001 From: Marc Siegel Date: Fri, 2 Aug 2013 15:45:12 -0400 Subject: [PATCH] (documentation: fix misspelling and replace @yield with @param block) --- lib/docile.rb | 4 ++-- lib/docile/execution.rb | 9 ++++----- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/lib/docile.rb b/lib/docile.rb index db6eea7..3cfd24d 100644 --- a/lib/docile.rb +++ b/lib/docile.rb @@ -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) diff --git a/lib/docile/execution.rb b/lib/docile/execution.rb index 66ffc68..efefd22 100644 --- a/lib/docile/execution.rb +++ b/lib/docile/execution.rb @@ -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)