Greetings!
Please review the pull request #47: Maint: Improve create_resources function's doc string opened by (nfagerlund)
Some more information about the pull request:
- Opened: Thu Aug 18 17:21:03 UTC 2011
- Based on: puppetlabs:2.7.x (99678f26369f7ac57a4125b6b391f2db832bbb4b)
- Requested merge: nfagerlund:maint/2.7.x/create_resources_documentation (a8b27debc09b02eb78b40b891db2f01f9b617406)
Description:
The create_resources function's doc string was not particularly clear and had
incorrect markdown formatting. This commit adds a more complete example which
demonstrates the necessary hash format, and changes the doc string to a
heredoc to simplify escaping.
Thanks!
The Pull Request Bot
Diff follows:
diff --git a/lib/puppet/parser/functions/create_resources.rb b/lib/puppet/parser/functions/create_resources.rb
index 3b8bb35..8b28151 100644
--- a/lib/puppet/parser/functions/create_resources.rb
+++ b/lib/puppet/parser/functions/create_resources.rb
@@ -1,12 +1,22 @@
-Puppet::Parser::Functions::newfunction(:create_resources, :doc => '
-Converts a hash into a set of resources and adds them to the catalog.
-Takes two parameters:
- create_resource($type, $resources)
- Creates resources of type $type from the $resources hash. Assumes that
- hash is in the following form:
- {title=>{parameters}}
- This is currently tested for defined resources, classes, as well as native types
-') do |args|
+Puppet::Parser::Functions::newfunction(:create_resources, :doc => <<-'ENDHEREDOC') do |args|
+ Converts a hash into a set of resources and adds them to the catalog.
+
+ This function takes two arguments: a resource type, and a hash describing a set of resources. The hash should be in the form `{title => {parameters} }`:
+
+ # A hash of user resources:
+ $myusers = {
+ 'nick' => { uid => '1330',
+ group => allstaff,
+ groups => ['developers', 'operations', 'release'], }
+ 'dan' => { uid => '1308',
+ group => allstaff,
+ groups => ['developers', 'prosvc', 'release'], }
+ }
+
+ create_resource(user, $myusers)
+
+ This function can be used to create defined resources and classes, as well as native resources.
+ ENDHEREDOC
raise ArgumentError, ("create_resources(): wrong number of arguments (#{args.length}; must be 2)") if args.length != 2
#raise ArgumentError, 'requires resource type and param hash' if args.size < 2
# figure out what kind of resource we are
@@ -19,7 +29,7 @@ Takes two parameters:
type_of_resource = :type
elsif resource = find_definition(type_name.downcase)
type_of_resource = :define
- else
+ else
raise ArgumentError, "could not create resource of unknown type #{type_name}"
end
end
-- You received this message because you are subscribed to the Google Groups "Puppet Developers" group.
To post to this group, send email to puppet-dev@googlegroups.com.
To unsubscribe from this group, send email to puppet-dev+unsubscr...@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/puppet-dev?hl=en.
