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

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/pick_default.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/pick_default.rb
index 0d499fba4..d94bb52aa 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/pick_default.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/pick_default.rb
@@ -3,9 +3,13 @@
 #
 module Puppet::Parser::Functions
   newfunction(:pick_default, :type => :rvalue, :doc => <<-DOC
-    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
-    If no value is found, it will return the last argument.
+    @summary
+      This function will return the first value in a list of values that is not undefined or an empty string.
+
+    @return
+      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
+      If no value is found, it will return the last argument.
 
     Typically, this function is used to check for a value in the Puppet
     Dashboard/Enterprise Console, and failover to a default value like the
@@ -13,15 +17,16 @@ module Puppet::Parser::Functions
 
       $real_jenkins_version = pick_default($::jenkins_version, '1.449')
 
-    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.
+    > *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.
 
-    Note that, contrary to the pick() function, the pick_default does not fail if
-    all arguments are empty. This allows pick_default to use an empty value as
-    default.
-DOC
+      Contrary to the pick() function, the pick_default does not fail if
+      all arguments are empty. This allows pick_default to use an empty value as
+      default.
+    DOC
              ) do |args|
     raise 'Must receive at least one argument.' if args.empty?
     default = args.last