X-Git-Url: https://git.adam-barratt.org.uk/?a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Fshell_escape.rb;h=0cf07e59ed133d5bf59f244ac71ffa55f581f63c;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hp=7306b7cf90834247dc7a4709e049a35e4949a2f2;hpb=6963202b4b62c2816655ac9532521b018fdf83bd;p=mirror%2Fdsa-puppet.git

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 7306b7cf9..0cf07e59e 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/shell_escape.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/shell_escape.rb
@@ -1,19 +1,21 @@
+require 'shellwords'
 #
 # shell_escape.rb
 #
-
-require 'shellwords'
-
 module Puppet::Parser::Functions
-  newfunction(:shell_escape, :type => :rvalue, :doc => <<-EOS
-Escapes a string so that it can be safely used in a Bourne shell command line.
+  newfunction(:shell_escape, :type => :rvalue, :doc => <<-DOC
+    @summary
+      Escapes a string so that it can be safely used in a Bourne shell command line.
+
+    @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.
+    >* 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.
-  EOS
-  ) do |arguments|
+    This function behaves the same as ruby's Shellwords.shellescape() function.
+  DOC
+             ) do |arguments|
 
     raise(Puppet::ParseError, "shell_escape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1