diff options
author | Jeff McCune <jeff@puppetlabs.com> | 2011-12-30 10:46:57 -0800 |
---|---|---|
committer | Jeff McCune <jeff@puppetlabs.com> | 2011-12-30 10:46:57 -0800 |
commit | 7aeeae3721f105d99a5cdd2e8110315791fd40bd (patch) | |
tree | 679b54fc45b775f0fdc705b28e4a5f1f923f803c /lib/puppet/parser/functions/validate_re.rb | |
parent | aa9948bfb32c4d88a04f24586224b628b5be0c8d (diff) | |
parent | bdba42dbb6328ccc5bb13f0777240fdb85e538ca (diff) | |
download | puppet-stdlib-7aeeae3721f105d99a5cdd2e8110315791fd40bd.tar.gz puppet-stdlib-7aeeae3721f105d99a5cdd2e8110315791fd40bd.tar.bz2 |
Merge branch 'v2.x'
* v2.x:
Docs: Clarify the use case for the anchor type
Docs: Remove author emails from stdlib functions
Docs: Copyedit function doc strings
Docs: Correct indentation of markdown code examples
Docs: Update documentation of stdlib classes
Docs: Update file_line documentation
Docs: Improve example in merge function
Diffstat (limited to 'lib/puppet/parser/functions/validate_re.rb')
-rw-r--r-- | lib/puppet/parser/functions/validate_re.rb | 18 |
1 files changed, 8 insertions, 10 deletions
diff --git a/lib/puppet/parser/functions/validate_re.rb b/lib/puppet/parser/functions/validate_re.rb index 583f26a..8033ca3 100644 --- a/lib/puppet/parser/functions/validate_re.rb +++ b/lib/puppet/parser/functions/validate_re.rb @@ -1,24 +1,22 @@ module Puppet::Parser::Functions newfunction(:validate_re, :doc => <<-'ENDHEREDOC') do |args| - Perform simple validation of a string against a regular expression. The second - argument of the function should be a string regular expression (without the //'s) - or an array of regular expressions. If none of the regular expressions in the array - match the string passed in, then an exception will be raised. + Perform simple validation of a string against one or more regular + expressions. The first argument of this function should be a string to + test, and the second argument should be a stringified regular expression + (without the // delimiters) or an array of regular expressions. If none + of the regular expressions match the string passed in, compilation will + abort with a parse error. - Example: - - These strings validate against the regular expressions + The following strings will validate against the regular expressions: validate_re('one', '^one$') validate_re('one', [ '^one', '^two' ]) - These strings do NOT validate + The following strings will fail to validate, causing compilation to abort: validate_re('one', [ '^two', '^three' ]) - Jeff McCune <jeff@puppetlabs.com> - ENDHEREDOC if args.length != 2 then raise Puppet::ParseError, ("validate_re(): wrong number of arguments (#{args.length}; must be 2)") |