summaryrefslogtreecommitdiff
path: root/lib/puppet/parser/functions/README.markdown
diff options
context:
space:
mode:
Diffstat (limited to 'lib/puppet/parser/functions/README.markdown')
-rw-r--r--lib/puppet/parser/functions/README.markdown17
1 files changed, 17 insertions, 0 deletions
diff --git a/lib/puppet/parser/functions/README.markdown b/lib/puppet/parser/functions/README.markdown
new file mode 100644
index 0000000..15d7495
--- /dev/null
+++ b/lib/puppet/parser/functions/README.markdown
@@ -0,0 +1,17 @@
+Functions
+=========
+
+Define functions in this directory.
+
+File paths should match the function name; for example, a function
+`myfunction`, defined like this:
+
+ Puppet::Parser::Functions::newfunction(
+ :myfunction,
+ :type => :statement,
+ :doc => "Documentation here."
+ ) do |vals|
+ # ...
+ end
+
+Should be found in `myfunction.rb` in this directory.