Skip to content

Commit 391c9c0

Browse files
author
Phil Friderici
committed
fix: add documentation to satisfy linting
Fixes the following warnings that do pop up while linting: [warn]: Missing documentation for Puppet type alias 'Zabbix::Historyics' at types/historyics.pp:1. [warn]: Missing a description for Puppet provider 'ruby' (resource type 'zabbix_host') at lib/puppet/provider/zabbix_host/ruby.rb:4. [warn]: Missing a description for Puppet provider 'ruby' (resource type 'zabbix_proxy') at lib/puppet/provider/zabbix_proxy/ruby.rb:4. [warn]: Missing a description for Puppet provider 'ruby' (resource type 'zabbix_template') at lib/puppet/provider/zabbix_template/ruby.rb:4. [warn]: Missing a description for Puppet provider 'ruby' (resource type 'zabbix_hostgroup') at lib/puppet/provider/zabbix_hostgroup/ruby.rb:4. [warn]: Missing a description for Puppet provider 'ruby' (resource type 'zabbix_application') at lib/puppet/provider/zabbix_application/ruby.rb:4. [warn]: Missing a description for Puppet provider 'ruby' (resource type 'zabbix_template_host') at lib/puppet/provider/zabbix_template_host/ruby.rb:4. [warn]: Missing a description for Puppet provider 'ruby' (resource type 'zabbix_userparameters') at lib/puppet/provider/zabbix_userparameters/ruby.rb:4.
1 parent 3460c63 commit 391c9c0

File tree

9 files changed

+10
-2
lines changed

9 files changed

+10
-2
lines changed

REFERENCE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
### Data types
5252

5353
* [`Zabbix::Databases`](#Zabbix--Databases): Type for supported databases by the zabbix module
54-
* [`Zabbix::Historyics`](#Zabbix--Historyics)
54+
* [`Zabbix::Historyics`](#Zabbix--Historyics): Type for size values in bytes (also allows k/K and m/M as appendix)
5555

5656
## Classes
5757

@@ -6343,7 +6343,7 @@ Alias of `Enum['postgresql', 'mysql', 'sqlite']`
63436343

63446344
### <a name="Zabbix--Historyics"></a>`Zabbix::Historyics`
63456345

6346-
The Zabbix::Historyics data type.
6346+
Type for size values in bytes (also allows k/K and m/M as appendix)
63476347

63486348
Alias of `Optional[Pattern[/^\d+[k|K|m|M]?$/]]`
63496349

lib/puppet/provider/zabbix_application/ruby.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
require_relative '../zabbix'
44
Puppet::Type.type(:zabbix_application).provide(:ruby, parent: Puppet::Provider::Zabbix) do
5+
desc 'Puppet provider for Zabbix application using the Zabbix API.2'
56
confine feature: :zabbixapi
67

78
def template_id

lib/puppet/provider/zabbix_host/ruby.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
require_relative '../zabbix'
44
Puppet::Type.type(:zabbix_host).provide(:ruby, parent: Puppet::Provider::Zabbix) do
5+
desc 'Puppet provider for managing Zabbix hosts. It uses the Zabbix API to create, read, update and delete hosts.'
56
confine feature: :zabbixapi
67

78
def self.instances

lib/puppet/provider/zabbix_hostgroup/ruby.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
require_relative '../zabbix'
44
Puppet::Type.type(:zabbix_hostgroup).provide(:ruby, parent: Puppet::Provider::Zabbix) do
5+
desc 'Puppet provider for managing Zabbix hostgroups. It defines methods to create, check if exists, and destroy Zabbix hostgroups using the Zabbix API.'
56
confine feature: :zabbixapi
67

78
def self.instances

lib/puppet/provider/zabbix_proxy/ruby.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
require_relative '../zabbix'
44
Puppet::Type.type(:zabbix_proxy).provide(:ruby, parent: Puppet::Provider::Zabbix) do
5+
desc 'Puppet provider for managing Zabbix proxies. It uses the Zabbix API to create, read, update and delete hosts, as well as changing them between active and passive modes.'
56
confine feature: :zabbixapi
67

78
def initialize(value = {})

lib/puppet/provider/zabbix_template/ruby.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
require_relative '../zabbix'
44
Puppet::Type.type(:zabbix_template).provide(:ruby, parent: Puppet::Provider::Zabbix) do
5+
desc 'Puppet provider that manages Zabbix templates by importing and exporting them in XML format, and creating, updating, or deleting various Zabbix configuration objects. It includes conditional logic based on the Zabbix version being used.'
56
confine feature: :zabbixapi
67

78
def create

lib/puppet/provider/zabbix_template_host/ruby.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
require_relative '../zabbix'
44
Puppet::Type.type(:zabbix_template_host).provide(:ruby, parent: Puppet::Provider::Zabbix) do
5+
desc 'Puppet provider that manages the association between Zabbix templates and hosts. It allows creating, checking the existence of, and deleting the association between a Zabbix template and a host, using the Zabbix API.'
56
confine feature: :zabbixapi
67
def template_name
78
@template_name ||= @resource[:name].split('@')[0]

lib/puppet/provider/zabbix_userparameters/ruby.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
require_relative '../zabbix'
44
Puppet::Type.type(:zabbix_userparameters).provide(:ruby, parent: Puppet::Provider::Zabbix) do
5+
desc 'Puppet provider that manages Zabbix user parameters. It allows users to define custom monitoring parameters in Zabbix, and provides methods for creating and checking the existence of a user parameter. It also has a placeholder method for destroying the user parameter.'
56
confine feature: :zabbixapi
67

78
def create

types/historyics.pp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1+
# @summary Type for size values in bytes (also allows k/K and m/M as appendix)
12
type Zabbix::Historyics = Optional[Pattern[/^\d+[k|K|m|M]?$/]]

0 commit comments

Comments
 (0)