Skip to content

Commit 9d00e8c

Browse files
author
Phil Friderici
committed
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.
1 parent 48174aa commit 9d00e8c

File tree

8 files changed

+23
-8
lines changed

8 files changed

+23
-8
lines changed

REFERENCE.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,12 @@
4141
### Resource types
4242

4343
* [`zabbix_application`](#zabbix_application): Manage zabbix applications Example: zabbix_application{"app1": ensure => present, template => 'template1', } It Raise exceptio
44-
* [`zabbix_host`](#zabbix_host): FQDN of the machine.
44+
* [`zabbix_host`](#zabbix_host): Manage zabbix hosts
4545
* [`zabbix_hostgroup`](#zabbix_hostgroup): Manage zabbix hostgroups
46-
* [`zabbix_proxy`](#zabbix_proxy): FQDN of the proxy.
47-
* [`zabbix_template`](#zabbix_template): The name of template.
46+
* [`zabbix_proxy`](#zabbix_proxy): Manage zabbix proxies
47+
* [`zabbix_template`](#zabbix_template): Manage zabbix templates
4848
* [`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
49-
* [`zabbix_userparameters`](#zabbix_userparameters): An unique name for this define.
49+
* [`zabbix_userparameters`](#zabbix_userparameters): Manage zabbix user templates
5050

5151
### Data types
5252

@@ -5973,7 +5973,7 @@ template to which the application is linked
59735973

59745974
### <a name="zabbix_host"></a>`zabbix_host`
59755975

5976-
FQDN of the machine.
5976+
Manage zabbix hosts
59775977

59785978
#### Properties
59795979

@@ -6112,7 +6112,7 @@ usually discover the appropriate provider for your platform.
61126112

61136113
### <a name="zabbix_proxy"></a>`zabbix_proxy`
61146114

6115-
FQDN of the proxy.
6115+
Manage zabbix proxies
61166116

61176117
#### Properties
61186118

@@ -6170,7 +6170,7 @@ usually discover the appropriate provider for your platform.
61706170

61716171
### <a name="zabbix_template"></a>`zabbix_template`
61726172

6173-
The name of template.
6173+
Manage zabbix templates
61746174

61756175
#### Properties
61766176

@@ -6289,7 +6289,7 @@ will usually discover the appropriate provider for your platform.
62896289

62906290
### <a name="zabbix_userparameters"></a>`zabbix_userparameters`
62916291

6292-
An unique name for this define.
6292+
Manage zabbix user templates
62936293

62946294
#### Properties
62956295

lib/puppet/type/zabbix_application.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
DOC
1414

1515
ensurable do
16+
desc 'The basic property that the resource should be in.'
1617
defaultvalues
1718
defaultto :present
1819
end

lib/puppet/type/zabbix_host.rb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# frozen_string_literal: true
22

33
Puppet::Type.newtype(:zabbix_host) do
4+
@doc = 'Manage zabbix hosts'
5+
46
ensurable do
7+
desc 'The basic property that the resource should be in.'
58
defaultvalues
69
defaultto :present
710
end

lib/puppet/type/zabbix_hostgroup.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
@doc = 'Manage zabbix hostgroups'
55

66
ensurable do
7+
desc 'The basic property that the resource should be in.'
78
defaultvalues
89
defaultto :present
910
end

lib/puppet/type/zabbix_proxy.rb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# frozen_string_literal: true
22

33
Puppet::Type.newtype(:zabbix_proxy) do
4+
@doc = 'Manage zabbix proxies'
5+
46
ensurable do
7+
desc 'The basic property that the resource should be in.'
58
defaultvalues
69
defaultto :present
710
end

lib/puppet/type/zabbix_template.rb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# frozen_string_literal: true
22

33
Puppet::Type.newtype(:zabbix_template) do
4+
@doc = 'Manage zabbix templates'
5+
46
ensurable do
7+
desc 'The basic property that the resource should be in.'
58
defaultvalues
69
defaultto :present
710

lib/puppet/type/zabbix_template_host.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
DOC
1313

1414
ensurable do
15+
desc 'The basic property that the resource should be in.'
1516
defaultvalues
1617
defaultto :present
1718
end

lib/puppet/type/zabbix_userparameters.rb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22

33
$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..'))
44
Puppet::Type.newtype(:zabbix_userparameters) do
5+
@doc = 'Manage zabbix user templates'
6+
57
ensurable do
8+
desc 'The basic property that the resource should be in.'
69
defaultvalues
710
defaultto :present
811
end

0 commit comments

Comments
 (0)