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%2Fbool2num.rb;h=bafe0bd436dcfa1ae6be69bff2b6ec7cab2bd179;hp=115467e76389fe5f37f338898c6e07c9547e2056;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/bool2num.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/bool2num.rb
index 115467e76..bafe0bd43 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/bool2num.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/bool2num.rb
@@ -3,20 +3,29 @@
 #
 module Puppet::Parser::Functions
   newfunction(:bool2num, :type => :rvalue, :doc => <<-DOC
-    Converts a boolean to a number. Converts the values:
+    @summary
+      Converts a boolean to a number.
+
+    Converts the values:
+      ```
       false, f, 0, n, and no to 0
       true, t, 1, y, and yes to 1
+      ```
     Requires a single boolean or string as an input.
 
-    Note that since Puppet 5.0.0 it is possible to create new data types for almost any
-    datatype using the type system and the built-in
-    [`Numeric.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-numeric),
-    [`Integer.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-integer), and
-    [`Float.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-float)
-    function are used to convert to numeric values.
+    > *Note:*
+      since Puppet 5.0.0 it is possible to create new data types for almost any
+      datatype using the type system and the built-in
+      [`Numeric.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-numeric),
+      [`Integer.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-integer), and
+      [`Float.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-float)
+      function are used to convert to numeric values.
+      ```
+      notice(Integer(false)) # Notices 0
+      notice(Float(true))    # Notices 1.0
+      ```
 
-        notice(Integer(false)) # Notices 0
-        notice(Float(true))    # Notices 1.0
+    @return [Integer] The converted value as a number
     DOC
              ) do |arguments|