Skip to content

Commit 4830d27

Browse files
committed
Fix length of the summary for puppet_function
[warn]: The length of the summary for puppet_function 'foo' exceeds the recommended limit of 140 characters.
1 parent e2d8764 commit 4830d27

File tree

3 files changed

+10
-5
lines changed

3 files changed

+10
-5
lines changed

lib/puppet/parser/functions/pick.rb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@
66
module Puppet::Parser::Functions
77
newfunction(:pick, type: :rvalue, doc: <<-EOS
88
@summary
9-
This function is similar to a coalesce function in SQL in that it will return
9+
This function will return
1010
the first value in a list of values that is not undefined or an empty string.
1111
12+
This function is similar to a coalesce function in SQL in that it will return
13+
1214
@return
1315
the first value in a list of values that is not undefined or an empty string.
1416

lib/puppet/parser/functions/validate_slength.rb

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@ module Puppet::Parser::Functions
77
newfunction(:validate_slength, doc: <<-DOC
88
@summary
99
Validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument.
10-
An optional third parameter can be given the minimum length. It fails if the first argument is not a string or array of strings,
11-
and if arg 2 and arg 3 are not convertable to a number.
10+
11+
An optional third parameter can be given the minimum length. It fails if the first argument is not a string or array of strings,
12+
and if arg 2 and arg 3 are not convertable to a number.
1213
1314
@return
1415
validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. Fail compilation if any of the checks fail.

lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@ module Puppet::Parser::Functions
77
newfunction(:validate_x509_rsa_key_pair, doc: <<-DOC
88
@summary
99
Validates a PEM-formatted X.509 certificate and RSA private key using
10-
OpenSSL. Verifies that the certficate's signature was created from the
11-
supplied key.
10+
OpenSSL.
11+
12+
Verifies that the certficate's signature was created from the
13+
supplied key.
1214
1315
@return
1416
Fail compilation if any value fails this check.

0 commit comments

Comments
 (0)