Skip to content

Commit dd36542

Browse files
committed
Fix "Missing documentation for Puppet function"
[warn]: Missing documentation for Puppet function 'foo' at lib/puppet/parser/functions/foo.rb:42 [warn]: Missing @return tag near lib/puppet/parser/functions/foo.rb:42
1 parent 2592c83 commit dd36542

File tree

10 files changed

+10
-10
lines changed

10 files changed

+10
-10
lines changed

lib/puppet/parser/functions/defined_with_params.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
Puppet::Parser::Functions.newfunction(:defined_with_params,
77
type: :rvalue,
8-
doc: <<-DOC,
8+
doc: <<-DOC
99
@summary
1010
Takes a resource reference and an optional hash of attributes.
1111

lib/puppet/parser/functions/dig44.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ module Puppet::Parser::Functions
88
:dig44,
99
type: :rvalue,
1010
arity: -2,
11-
doc: <<-DOC,
11+
doc: <<-DOC
1212
@summary
1313
**DEPRECATED**: Looks up into a complex structure of arrays and hashes and returns a value
1414
or the default value if nothing was found.

lib/puppet/parser/functions/ensure_resource.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
Puppet::Parser::Functions.newfunction(:ensure_resource,
77
type: :statement,
8-
doc: <<-DOC,
8+
doc: <<-DOC
99
@summary
1010
Takes a resource type, title, and a list of attributes that describe a
1111
resource.

lib/puppet/parser/functions/ensure_resources.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Puppet::Parser::Functions.newfunction(:ensure_resources,
66
type: :statement,
7-
doc: <<-DOC,
7+
doc: <<-DOC
88
@summary
99
Takes a resource type, title (only hash), and a list of attributes that describe a
1010
resource.

lib/puppet/parser/functions/fqdn_rand_string.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
:fqdn_rand_string,
55
arity: -2,
66
type: :rvalue,
7-
doc: <<-DOC,
7+
doc: <<-DOC
88
@summary
99
Generates a random alphanumeric string. Combining the `$fqdn` fact and an
1010
optional seed for repeatable randomness.

lib/puppet/parser/functions/fqdn_rotate.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
Puppet::Parser::Functions.newfunction(
77
:fqdn_rotate,
88
type: :rvalue,
9-
doc: <<-DOC,
9+
doc: <<-DOC
1010
@summary
1111
Rotates an array or string a random number of times, combining the `$fqdn` fact
1212
and an optional seed for repeatable randomness.

lib/puppet/parser/functions/getparam.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
Puppet::Parser::Functions.newfunction(:getparam,
77
type: :rvalue,
8-
doc: <<-'DOC',
8+
doc: <<-'DOC'
99
@summary
1010
Returns the value of a resource's parameter.
1111

lib/puppet/parser/functions/pw_hash.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
:pw_hash,
88
type: :rvalue,
99
arity: 3,
10-
doc: <<-DOC,
10+
doc: <<-DOC
1111
@summary
1212
Hashes a password using the crypt function. Provides a hash usable
1313
on most POSIX systems.

lib/puppet/parser/functions/seeded_rand.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
:seeded_rand,
88
arity: 2,
99
type: :rvalue,
10-
doc: <<-DOC,
10+
doc: <<-DOC
1111
@summary
1212
Generates a random whole number greater than or equal to 0 and less than MAX, using the value of SEED for repeatable randomness.
1313

lib/puppet/parser/functions/try_get_value.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ module Puppet::Parser::Functions
88
:try_get_value,
99
type: :rvalue,
1010
arity: -2,
11-
doc: <<-DOC,
11+
doc: <<-DOC
1212
@summary
1313
**DEPRECATED:** this function is deprecated, please use dig() instead.
1414

0 commit comments

Comments
 (0)