configurable.rb in mattock-0.2.13

- old
+ new

@@ -3,10 +3,13 @@
   #
   #Settings can have default values or be required (as opposed to defaulting to
   #nil).  Settings and their defaults are inherited (and can be overridden) by
   #subclasses.
   #
+  #Mattock also includes a yard-extension that will document settings of a
+  #Configurable
+  #
   #@example (see ClassMethods)
   module Configurable
     RequiredField = Object.new
     class << RequiredField
       def to_s
@@ -20,10 +23,10 @@
     RequiredField.freeze
 
     #Describes class level DSL & machinery for working with configuration
     #managment.
     #
-    #@example Quick example
+    #@example
     #    class ConfExample
     #      include Configurable
     #
     #      setting :foo
     #      settings :bar => 1, :baz => 3