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.rb;h=e31dc95de05d0825cc0501f509b94df2abaf0ce7;hp=38ce5cd9945e6be156a9c908523444e6ccd0d9ba;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/pick.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/pick.rb
index 38ce5cd99..e31dc95de 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/pick.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/pick.rb
@@ -2,19 +2,25 @@
 # pick.rb
 #
 module Puppet::Parser::Functions
-  newfunction(:pick, :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.
+  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.
+
+    @return
+      the first value in a list of values that is not undefined or an empty string.
+
     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:
 
-      $real_jenkins_version = pick($::jenkins_version, '1.449')
+    ```$real_jenkins_version = pick($::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.
-DOC
+    > *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)