Improve documentation
This commit is contained in:
parent
9dcddc83c2
commit
67756fa69e
|
@ -3,7 +3,7 @@ require "docile/execution"
|
||||||
require "docile/fallback_context_proxy"
|
require "docile/fallback_context_proxy"
|
||||||
require "docile/chaining_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
|
module Docile
|
||||||
extend Execution
|
extend Execution
|
||||||
|
|
||||||
|
@ -57,12 +57,12 @@ module Docile
|
||||||
# 2. Each command returns the next DSL context object
|
# 2. Each command returns the next DSL context object
|
||||||
# 3. The final return value is the value returned by the last command
|
# 3. The final return value is the value returned by the last command
|
||||||
#
|
#
|
||||||
# @example Use a String as a DSL
|
# @example Use a frozen String as a DSL
|
||||||
# Docile.dsl_eval_immutable("Hello, world!") do
|
# Docile.dsl_eval_immutable("I'm immutable!".freeze) do
|
||||||
# reverse
|
# reverse
|
||||||
# upcase
|
# upcase
|
||||||
# end
|
# end
|
||||||
# #=> "!DLROW ,OLLEH"
|
# #=> "!ELBATUMMI M'I"
|
||||||
#
|
#
|
||||||
# @example Use a Float as a DSL
|
# @example Use a Float as a DSL
|
||||||
# Docile.dsl_eval_immutable(84.5) do
|
# Docile.dsl_eval_immutable(84.5) do
|
||||||
|
|
|
@ -9,7 +9,9 @@ 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 [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
|
# @param args [Array] arguments to be passed to the block
|
||||||
# @yield the block of DSL commands to be executed
|
# @yield the block of DSL commands to be executed
|
||||||
# @return [Object] the return value of the block
|
# @return [Object] the return value of the block
|
||||||
|
|
Loading…
Reference in New Issue