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%2Fshell_escape.rb;h=0cf07e59ed133d5bf59f244ac71ffa55f581f63c;hp=96fea2088eb3509d1f4fa44f72b02500ab789dd6;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/shell_escape.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/shell_escape.rb
index 96fea2088..0cf07e59e 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/shell_escape.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/shell_escape.rb
@@ -4,9 +4,13 @@ require 'shellwords'
 #
 module Puppet::Parser::Functions
   newfunction(:shell_escape, :type => :rvalue, :doc => <<-DOC
-    Escapes a string so that it can be safely used in a Bourne shell command line.
+    @summary
+      Escapes a string so that it can be safely used in a Bourne shell command line.
 
-    Note that the resulting string should be used unquoted and is not intended for use in double quotes nor in single
+    @return
+      A string of characters with metacharacters converted to their escaped form.
+
+    >* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single
     quotes.
 
     This function behaves the same as ruby's Shellwords.shellescape() function.