Commit graph

7 commits

Author SHA1 Message Date
David Schmitt
55ece7815a (MAINT) validate_re: Clarify docs and error message 2015-09-17 18:48:32 +01:00
Jeff McCune
f156e554d4 (maint) Comment Ken's fix to String#any?
Just added a comment about why we're doing what we're doing.
2012-03-09 14:08:54 -08:00
Ken Barber
010fb5e568 (#13018) Fix missing method any? message for ruby 1.9.x
The any? method doesn't exist for 1.9.x, this converts a string to a single
element array to work around the problem.
2012-03-07 19:55:21 -08:00
Jeff McCune
41b07232e4 (#12357) Add ability to display an error message from validate_re
I've seen a number of times the following error displayed to the end
user:

    validate_re(): "" does not match "^true$|^false$" at /p/t/f.pp:40

This is an absolutely horrific error message.  I'm to blame for it.
Users stumble over this quite often and they shouldn't have to go read
the code to sort out what's happening.

This patch makes an effort to fix the problem by adding a third,
optional, argument to validate_re().  This third argument will be the
message thrown back in the exception which will be displayed to the end
user.

This sets the stage for nicer error messages coming from modules we
write.

This patch is backwards compatible but is a new feature.
2012-03-07 15:33:27 -08:00
nfagerlund
9e87fd1457 Docs: Remove author emails from stdlib functions
Author email addresses were included in the doc strings for some (but not all)
stdlib functions. This commit removes them in the interest of consistency.
2011-08-18 12:39:05 -07:00
nfagerlund
4b5dfcc733 Docs: Copyedit function doc strings
This commit makes several minor consistency and wording edits to the doc
strings of the stdlib functions.
2011-08-18 12:39:04 -07:00
Jeff McCune
d381a5b74f (#7657) Add basic validate_re function
While developing Puppet Modules with class parameters, data from the
user should be validated as per the Style Guide.  Puppet should fail
early and hard in the situation of invalid data being passed into the
module.

This function provides a more concise method to the alternative of using
if statements in the Puppet manifests.
2011-05-25 12:38:15 -07:00