lib/yaml_extend.rb in yaml_extend-0.1.0 vs lib/yaml_extend.rb in yaml_extend-0.1.1
- old
+ new
@@ -13,12 +13,10 @@
#
# Extended variant of the #load_file method by providing the
# ability to inherit from other YAML file(s)
#
# @param yaml_path [String] the path to the yaml file to be loaded
- # @param inheritance_key [String|Array]
- # The key used in the yaml file to extend from another YAML file.
- # Use an Array if you want to use a tree structure key like "options.extends" => ['options','extends']
+ # @param inheritance_key [String|Array] The key used in the yaml file to extend from another YAML file. Use an Array if you want to use a tree structure key like "options.extends" => ['options','extends']
# @param extend_existing_arrays [Boolean] extend existing arrays instead of replacing them
# @param config [Hash] a hash to be merged into the result, usually only recursivly called by the method itself
#
# @return [Hash] the resulting yaml config
#