fix: add documentation to satisfy linting

Fixes the following warnings that do pop up while linting: [warn]: Missing a description for Puppet resource property 'ensure' at lib/puppet/type/zabbix_host.rb:4. [warn]: Missing a description for Puppet resource property 'ensure' at lib/puppet/type/zabbix_proxy.rb:4. [warn]: Missing a description for Puppet resource property 'ensure' at lib/puppet/type/zabbix_template.rb:4. [warn]: Missing a description for Puppet resource property 'ensure' at lib/puppet/type/zabbix_hostgroup.rb:6. [warn]: Missing a description for Puppet resource property 'ensure' at lib/puppet/type/zabbix_application.rb:15. [warn]: Missing a description for Puppet resource property 'ensure' at lib/puppet/type/zabbix_template_host.rb:14. [warn]: Missing a description for Puppet resource property 'ensure' at lib/puppet/type/zabbix_userparameters.rb:5.
voxpupuli · Jul 24, 2023 · 9d00e8c · 9d00e8c
1 parent 48174aa
commit 9d00e8c
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 8 deletions.
diff --git a/REFERENCE.md b/REFERENCE.md
@@ -41,12 +41,12 @@
 ### Resource types
 
 * [`zabbix_application`](#zabbix_application): Manage zabbix applications  Example:   zabbix_application{"app1":     ensure   => present,     template => 'template1',   } It Raise exceptio
-* [`zabbix_host`](#zabbix_host): FQDN of the machine.
+* [`zabbix_host`](#zabbix_host): Manage zabbix hosts
 * [`zabbix_hostgroup`](#zabbix_hostgroup): Manage zabbix hostgroups
-* [`zabbix_proxy`](#zabbix_proxy): FQDN of the proxy.
-* [`zabbix_template`](#zabbix_template): The name of template.
+* [`zabbix_proxy`](#zabbix_proxy): Manage zabbix proxies
+* [`zabbix_template`](#zabbix_template): Manage zabbix templates
 * [`zabbix_template_host`](#zabbix_template_host): Link or Unlink template to host. Only for Zabbix < 6.0!  Example:   zabbix_template_host{ 'mysql_template@db1':     ensure => present,   } Na
-* [`zabbix_userparameters`](#zabbix_userparameters): An unique name for this define.
+* [`zabbix_userparameters`](#zabbix_userparameters): Manage zabbix user templates
 
 ### Data types
 
@@ -5973,7 +5973,7 @@ template to which the application is linked
 
 ### <a name="zabbix_host"></a>`zabbix_host`
 
-FQDN of the machine.
+Manage zabbix hosts
 
 #### Properties
 
@@ -6112,7 +6112,7 @@ usually discover the appropriate provider for your platform.
 
 ### <a name="zabbix_proxy"></a>`zabbix_proxy`
 
-FQDN of the proxy.
+Manage zabbix proxies
 
 #### Properties
 
@@ -6170,7 +6170,7 @@ usually discover the appropriate provider for your platform.
 
 ### <a name="zabbix_template"></a>`zabbix_template`
 
-The name of template.
+Manage zabbix templates
 
 #### Properties
 
@@ -6289,7 +6289,7 @@ will usually discover the appropriate provider for your platform.
 
 ### <a name="zabbix_userparameters"></a>`zabbix_userparameters`
 
-An unique name for this define.
+Manage zabbix user templates
 
 #### Properties
 

diff --git a/lib/puppet/type/zabbix_application.rb b/lib/puppet/type/zabbix_application.rb
@@ -13,6 +13,7 @@
   DOC
 
   ensurable do
+    desc 'The basic property that the resource should be in.'
     defaultvalues
     defaultto :present
   end

diff --git a/lib/puppet/type/zabbix_host.rb b/lib/puppet/type/zabbix_host.rb
@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 Puppet::Type.newtype(:zabbix_host) do
+  @doc = 'Manage zabbix hosts'
+
   ensurable do
+    desc 'The basic property that the resource should be in.'
     defaultvalues
     defaultto :present
   end

diff --git a/lib/puppet/type/zabbix_hostgroup.rb b/lib/puppet/type/zabbix_hostgroup.rb
@@ -4,6 +4,7 @@
   @doc = 'Manage zabbix hostgroups'
 
   ensurable do
+    desc 'The basic property that the resource should be in.'
     defaultvalues
     defaultto :present
   end

diff --git a/lib/puppet/type/zabbix_proxy.rb b/lib/puppet/type/zabbix_proxy.rb
@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 Puppet::Type.newtype(:zabbix_proxy) do
+  @doc = 'Manage zabbix proxies'
+
   ensurable do
+    desc 'The basic property that the resource should be in.'
     defaultvalues
     defaultto :present
   end

diff --git a/lib/puppet/type/zabbix_template.rb b/lib/puppet/type/zabbix_template.rb
@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 Puppet::Type.newtype(:zabbix_template) do
+  @doc = 'Manage zabbix templates'
+
   ensurable do
+    desc 'The basic property that the resource should be in.'
     defaultvalues
     defaultto :present
 

diff --git a/lib/puppet/type/zabbix_template_host.rb b/lib/puppet/type/zabbix_template_host.rb
@@ -12,6 +12,7 @@
   DOC
 
   ensurable do
+    desc 'The basic property that the resource should be in.'
     defaultvalues
     defaultto :present
   end

diff --git a/lib/puppet/type/zabbix_userparameters.rb b/lib/puppet/type/zabbix_userparameters.rb
@@ -2,7 +2,10 @@
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..'))
 Puppet::Type.newtype(:zabbix_userparameters) do
+  @doc = 'Manage zabbix user templates'
+
   ensurable do
+    desc 'The basic property that the resource should be in.'
     defaultvalues
     defaultto :present
   end