X-Git-Url: https://git.adam-barratt.org.uk/?a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Fpick.rb;h=e31dc95de05d0825cc0501f509b94df2abaf0ce7;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hp=fdd0aefd7225a5566d9c8334701aa30c7372efc7;hpb=ad88f67c13ae0f1a08936dad643f1e3509ab5f40;p=mirror%2Fdsa-puppet.git

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/pick.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/pick.rb
index fdd0aefd7..e31dc95de 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/pick.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/pick.rb
@@ -1,29 +1,32 @@
+#
+# pick.rb
+#
 module Puppet::Parser::Functions
- newfunction(:pick, :type => :rvalue, :doc => <<-EOS
+  newfunction(:pick, :type => :rvalue, :doc => <<-EOS
+    @summary
+      This function is similar to a coalesce function in SQL in that it will return
+      the first value in a list of values that is not undefined or an empty string.
 
-This function is similar to a coalesce function in SQL in that it will return
-the first value in a list of values that is not undefined or an empty string
-(two things in Puppet that will return a boolean false value). Typically,
-this function is used to check for a value in the Puppet Dashboard/Enterprise
-Console, and failover to a default value like the following:
+    @return
+      the first value in a list of values that is not undefined or an empty string.
 
-  $real_jenkins_version = pick($::jenkins_version, '1.449')
+    Typically, this function is used to check for a value in the Puppet
+    Dashboard/Enterprise Console, and failover to a default value like the following:
 
-The value of $real_jenkins_version will first look for a top-scope variable
-called 'jenkins_version' (note that parameters set in the Puppet Dashboard/
-Enterprise Console are brought into Puppet as top-scope variables), and,
-failing that, will use a default value of 1.449.
+    ```$real_jenkins_version = pick($::jenkins_version, '1.449')```
 
-EOS
-) do |args|
-   args = args.compact
-   args.delete(:undef)
-   args.delete(:undefined)
-   args.delete("")
-   if args[0].to_s.empty? then
-     fail Puppet::ParseError, "pick(): must receive at least one non empty value"
-   else
-     return args[0]
-   end
- end
+    > *Note:*
+      The value of $real_jenkins_version will first look for a top-scope variable
+      called 'jenkins_version' (note that parameters set in the Puppet Dashboard/
+      Enterprise Console are brought into Puppet as top-scope variables), and,
+      failing that, will use a default value of 1.449.
+  EOS
+             ) do |args|
+    args = args.compact
+    args.delete(:undef)
+    args.delete(:undefined)
+    args.delete('')
+    raise Puppet::ParseError, 'pick(): must receive at least one non empty value' if args[0].to_s.empty?
+    return args[0]
+  end
 end