summaryrefslogtreecommitdiff
path: root/lib/puppet/parser/functions/str2bool.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/puppet/parser/functions/str2bool.rb')
-rw-r--r--lib/puppet/parser/functions/str2bool.rb3
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/puppet/parser/functions/str2bool.rb b/lib/puppet/parser/functions/str2bool.rb
index f3a6d6c..c320da6 100644
--- a/lib/puppet/parser/functions/str2bool.rb
+++ b/lib/puppet/parser/functions/str2bool.rb
@@ -4,6 +4,9 @@
module Puppet::Parser::Functions
newfunction(:str2bool, :type => :rvalue, :doc => <<-EOS
+This converts a string to a boolean. This attempt to convert strings that
+contain things like: y, 1, t, true to 'true' and strings that contain things
+like: 0, f, n, false, no to 'false'.
EOS
) do |arguments|