summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Keiser <jkeiser@opscode.com>2013-12-03 09:07:05 -0800
committerJohn Keiser <jkeiser@opscode.com>2013-12-03 09:07:05 -0800
commit8860f23b355f34fecf0e704a918f43419c8996b6 (patch)
treea2d06a9cf7ba9fd6e08aa59028158abdb0e54eec
parented46272e4dcf47a2600d28aee83b72f4ea656f0a (diff)
downloadmixlib-config-8860f23b355f34fecf0e704a918f43419c8996b6.tar.gz
Fix example syntax
-rw-r--r--lib/mixlib/config.rb7
1 files changed, 4 insertions, 3 deletions
diff --git a/lib/mixlib/config.rb b/lib/mixlib/config.rb
index 7e48393..3ef6a3c 100644
--- a/lib/mixlib/config.rb
+++ b/lib/mixlib/config.rb
@@ -120,9 +120,11 @@ module Mixlib
#
# Hash of values the user has set.
#
+ # === Examples
+ #
# For example, this config class:
#
- # class MyConfig << Mixlib::Config
+ # class MyConfig < Mixlib::Config
# default :will_be_set, 1
# default :will_be_set_to_default, 1
# default :will_not_be_set, 1
@@ -138,11 +140,10 @@ module Mixlib
# MyConfig.will_be_set_to_default = 1
# MyConfig.computed_value = 2
# MyConfig.group.x = 3
- # MyConfig.save
#
# produces this:
#
- # {
+ # MyConfig.save == {
# :x => 2,
# :will_be_set => 2,
# :will_be_set_to_default => 1,