From 67756fa69e8454d44ee08c63b08c56f41359b6c1 Mon Sep 17 00:00:00 2001 From: Marc Siegel Date: Mon, 29 Jul 2013 00:14:15 -0400 Subject: [PATCH] Improve documentation --- lib/docile.rb | 8 ++++---- lib/docile/execution.rb | 4 +++- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/lib/docile.rb b/lib/docile.rb index 21e5a89..db6eea7 100644 --- a/lib/docile.rb +++ b/lib/docile.rb @@ -3,7 +3,7 @@ require "docile/execution" require "docile/fallback_context_proxy" require "docile/chaining_fallback_context_proxy" -# Docile keeps your Ruby DSLs tame and well-behaved +# Docile keeps your Ruby DSLs tame and well-behaved. module Docile extend Execution @@ -57,12 +57,12 @@ module Docile # 2. Each command returns the next DSL context object # 3. The final return value is the value returned by the last command # - # @example Use a String as a DSL - # Docile.dsl_eval_immutable("Hello, world!") do + # @example Use a frozen String as a DSL + # Docile.dsl_eval_immutable("I'm immutable!".freeze) do # reverse # upcase # end - # #=> "!DLROW ,OLLEH" + # #=> "!ELBATUMMI M'I" # # @example Use a Float as a DSL # Docile.dsl_eval_immutable(84.5) do diff --git a/lib/docile/execution.rb b/lib/docile/execution.rb index 85c1d12..66ffc68 100644 --- a/lib/docile/execution.rb +++ b/lib/docile/execution.rb @@ -9,7 +9,9 @@ module Docile # # @param dsl [Object] context object whose methods make up the # (initial) DSL - # @param proxy_type [Class] class to instantiate as the proxy context + # @param proxy_type [FallbackContextProxy, + # ChainingFallbackContextProxy] + # class to instantiate as the proxy context # @param args [Array] arguments to be passed to the block # @yield the block of DSL commands to be executed # @return [Object] the return value of the block