Skip to content

Commit 863b42f

Browse files
committed
Add missing @summary for data types
1 parent b82c762 commit 863b42f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+42
-39
lines changed

types/absolutepath.pp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
# A strict absolutepath type
1+
# @summary A strict absolutepath type
22
type Stdlib::Absolutepath = Variant[Stdlib::Windowspath, Stdlib::Unixpath]

types/base32.pp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
# Type to match base32 String
1+
# @summary Type to match base32 String
22
type Stdlib::Base32 = Pattern[/\A[a-z2-7]+={,6}\z/, /\A[A-Z2-7]+={,6}\z/]

types/base64.pp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
# Type to match base64 String
1+
# @summary Type to match base64 String
22
type Stdlib::Base64 = Pattern[/\A[a-zA-Z0-9\/\+]+={,2}\z/]

types/compat/absolute_path.pp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Emulate the is_absolute_path and validate_absolute_path functions
1+
# @summary Emulate the is_absolute_path and validate_absolute_path functions
22
#
33
# The first pattern is originally from is_absolute_path, which had it from 2.7.x's lib/puppet/util.rb Puppet::Util.absolute_path?
44
# slash = '[\\\\/]'

types/compat/array.pp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
# Emulate the is_array and validate_array functions
1+
# @summary Emulate the is_array and validate_array functions
22
type Stdlib::Compat::Array = Array[Any]

types/compat/bool.pp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
# Emulate the is_bool and validate_bool functions
1+
# @summary Emulate the is_bool and validate_bool functions
22
type Stdlib::Compat::Bool = Boolean

types/compat/float.pp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Emulate the is_float function
1+
# @summary Emulate the is_float function
22
# The regex is what's currently used in is_float
33
# To keep your development moving forward, you can also add a deprecation warning using the Integer type:
44
#

types/compat/hash.pp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
# Emulate the is_hash and validate_hash functions
1+
# @summary Emulate the is_hash and validate_hash functions
22
type Stdlib::Compat::Hash = Hash[Any, Any]

types/compat/integer.pp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Emulate the is_integer and validate_integer functions
1+
# @summary Emulate the is_integer and validate_integer functions
22
# The regex is what's currently used in is_integer
33
# validate_numeric also allows range checking, which cannot be mapped to the string parsing inside the function.
44
# For full backwards compatibility, you will need to keep the validate_numeric call around to catch everything.

types/compat/ip_address.pp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
# Validate an IP address
1+
# @summary Validate an IP address
22
type Stdlib::Compat::Ip_address = Variant[Stdlib::Compat::Ipv4, Stdlib::Compat::Ipv6]

0 commit comments

Comments
 (0)