diff options
author | Ashley Penney <ashley.penney@puppetlabs.com> | 2014-06-18 10:02:07 -0400 |
---|---|---|
committer | Ashley Penney <ashley.penney@puppetlabs.com> | 2014-06-18 10:02:07 -0400 |
commit | f0495091551d439f27fc0ef86a9f23b81e1138eb (patch) | |
tree | a40497e84e59bedf2d54722bd968ea7c4bda686f /README.markdown | |
parent | ffe21fc67491c4502114505c82142781d72720ab (diff) | |
parent | 2062f9734bc955be896183790afc355aab428747 (diff) |
Merge pull request #270 from raphink/dev/private
Add private() function
Diffstat (limited to 'README.markdown')
-rw-r--r-- | README.markdown | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown index e9ad53b..51adefe 100644 --- a/README.markdown +++ b/README.markdown @@ -725,6 +725,27 @@ Will return: ['pa','pb','pc'] - *Type*: rvalue + +private +------- +This function sets the current class or definition as private. +Calling the class or definition from outside the current module will fail. + +*Examples:* + + private() + +called in class `foo::bar` will output the following message if class is called +from outside module `foo`: + + Class foo::bar is private + +You can specify the error message you want to use as a parameter: + + private("You're not supposed to do that!") + +- *Type*: statement + range ----- When given range in the form of (start, stop) it will extrapolate a range as |