summaryrefslogtreecommitdiff
path: root/lib/puppet/parser/functions/delete.rb
diff options
context:
space:
mode:
authorKen Barber <ken@bob.sh>2011-07-29 23:09:30 +0100
committerKen Barber <ken@bob.sh>2011-07-29 23:09:30 +0100
commita1cae426f1d6b8f2c19184ec8aac3ebc47d97744 (patch)
tree2d40ab0b183ae285560569e625ee41df79e39784 /lib/puppet/parser/functions/delete.rb
parent19313b43ea04066a88a0b78e83650ac52785e2e9 (diff)
(#3) Provide documentation for remaining functions.
Diffstat (limited to 'lib/puppet/parser/functions/delete.rb')
-rw-r--r--lib/puppet/parser/functions/delete.rb9
1 files changed, 8 insertions, 1 deletions
diff --git a/lib/puppet/parser/functions/delete.rb b/lib/puppet/parser/functions/delete.rb
index 0d208b5..ab8f75b 100644
--- a/lib/puppet/parser/functions/delete.rb
+++ b/lib/puppet/parser/functions/delete.rb
@@ -7,11 +7,18 @@
module Puppet::Parser::Functions
newfunction(:delete, :type => :rvalue, :doc => <<-EOS
+Deletes a selected element from an array.
+
+*Examples:*
+
+ delete(['a','b','c'], 'b')
+
+Would return: ['a','c']
EOS
) do |arguments|
if (arguments.size != 2) then
- raise(Puppet::ParseError, "is_valid_netmask(): Wrong number of arguments "+
+ raise(Puppet::ParseError, "delete(): Wrong number of arguments "+
"given #{arguments.size} for 2")
end