summaryrefslogtreecommitdiff
path: root/lib/puppet/parser/functions/validate_string.rb
diff options
context:
space:
mode:
authorJeff McCune <jeff@puppetlabs.com>2011-12-30 11:48:21 -0800
committerJeff McCune <jeff@puppetlabs.com>2011-12-30 11:48:21 -0800
commit80c9a8feeae6203026f61215e100e95078c61a04 (patch)
treee70920f96b88bdc9e985e2439f395371d5ffe2be /lib/puppet/parser/functions/validate_string.rb
parent1434f3cea6f6e2a1b939d91cb5ff66338cc87d32 (diff)
parenta8d4bbd9e234ea577e27d83df95a61b374ac484b (diff)
downloadpuppet-stdlib-80c9a8feeae6203026f61215e100e95078c61a04.tar.gz
puppet-stdlib-80c9a8feeae6203026f61215e100e95078c61a04.tar.bz2
Merge branch 'v2.1.x' into v2.2.x
* v2.1.x: (maint) Add semantic versioning info to README 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_string.rb')
-rw-r--r--lib/puppet/parser/functions/validate_string.rb12
1 files changed, 5 insertions, 7 deletions
diff --git a/lib/puppet/parser/functions/validate_string.rb b/lib/puppet/parser/functions/validate_string.rb
index d0e1376..e667794 100644
--- a/lib/puppet/parser/functions/validate_string.rb
+++ b/lib/puppet/parser/functions/validate_string.rb
@@ -1,17 +1,15 @@
module Puppet::Parser::Functions
newfunction(:validate_string, :doc => <<-'ENDHEREDOC') do |args|
- Validate all passed values are a string data structure
- value does not pass the check.
+ Validate that all passed values are string data structures. Abort catalog
+ compilation if any value fails this check.
- Example:
-
- These values validate
+ The following values will pass:
$my_string = "one two"
- validate_string($my_string)
+ validate_string($my_string, 'three')
- These values do NOT validate
+ The following values will fail, causing compilation to abort:
validate_string(true)
validate_string([ 'some', 'array' ])