summaryrefslogtreecommitdiff
path: root/lib/puppet/parser/functions/bool2num.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/puppet/parser/functions/bool2num.rb')
-rw-r--r--lib/puppet/parser/functions/bool2num.rb4
1 files changed, 4 insertions, 0 deletions
diff --git a/lib/puppet/parser/functions/bool2num.rb b/lib/puppet/parser/functions/bool2num.rb
index b2989d0..9a07a8a 100644
--- a/lib/puppet/parser/functions/bool2num.rb
+++ b/lib/puppet/parser/functions/bool2num.rb
@@ -4,6 +4,10 @@
module Puppet::Parser::Functions
newfunction(:bool2num, :type => :rvalue, :doc => <<-EOS
+ 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.
EOS
) do |arguments|