Add better docs about duplicate resource failures

This commit adds better inline documentation
explaining how replicate resource definitions can
occur if the resource exists and does not have
matching parameters.

diff --git a/lib/puppet/parser/functions/ensure_resource.rb b/lib/puppet/parser/functions/ensure_resource.rb
index 8f9eadf28ce441c19a5c9e57a46bca57ad556257..3205b9b1db188203c2a389af9d71ed2073e53eac 100644 (file)
--- a/lib/puppet/parser/functions/ensure_resource.rb
+++ b/lib/puppet/parser/functions/ensure_resource.rb
@@ -14,6 +14,11 @@ resource.
 This example only creates the resource if it does not already exist:
 
     ensure_resource('user, 'dan', {'ensure' => 'present' })
+
+If the resource already exists but does not match the specified parameters,
+this function will attempt to recreate the resource leading to a duplicate
+resource definition error.
+
 ENDOFDOC
 ) do |vals|
   type, title, params = vals