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%2Fstr2bool.rb;h=165cf5d641ca235339569773ff11d6b20b62a753;hp=5f8b8fecdf949e7c5d61c1e5ab7f4947664ea180;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/str2bool.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/str2bool.rb
index 5f8b8fecd..165cf5d64 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/str2bool.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/str2bool.rb
@@ -3,11 +3,14 @@
 #
 module Puppet::Parser::Functions
   newfunction(:str2bool, :type => :rvalue, :doc => <<-DOC
-    This converts a string to a boolean. This attempt to convert strings that
-    contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things
-    like: 0, F,f, N,n, false, FALSE, no to 'false'.
+    @summary
+      This converts a string to a boolean.
 
-    Note that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value.
+    @return
+      This attempt to convert to boolean strings that contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things
+      like: 0, F,f, N,n, false, FALSE, no to 'false'.
+
+    > *Note:* that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value.
     See the function new() in Puppet for details what the Boolean data type supports.
   DOC
              ) do |arguments|