Skip to content

Commit

Permalink
Merge pull request #2177 from DanCech/function-plugin-docs
Browse files Browse the repository at this point in the history
clarify function plugin docs
  • Loading branch information
deniszh committed Jan 2, 2018
2 parents d253689 + 1caf31f commit 8921e8f
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ Function Plugins

Function plugins can define additional functions for use in render calls.

A function plugin is simply a file defining one or more functions and exporting ``SeriesFunctions`` and/or ``PieFunctions``
A function plugin is simply a file defining one or more functions and exporting dictionaries of ``SeriesFunctions`` and/or ``PieFunctions``.
When Graphite loads the plugin it will add functions in ``SeriesFunctions`` and/or ``PieFunctions`` to the list of available functions.

Each exposed function must accept at least a ``requestContext`` and ``seriesList`` parameter, and may accept additional parameters as needed.

Expand Down

0 comments on commit 8921e8f

Please sign in to comment.