Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / shell_escape.rb
index 96fea20..0cf07e5 100644 (file)
@@ -4,9 +4,13 @@ require 'shellwords'
 #
 module Puppet::Parser::Functions
   newfunction(:shell_escape, :type => :rvalue, :doc => <<-DOC
 #
 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.
     quotes.
 
     This function behaves the same as ruby's Shellwords.shellescape() function.