From 6239f6ab2f68ffc32dc812c4f74613101b4c7995 Mon Sep 17 00:00:00 2001 From: Waleed El-Geresy Date: Wed, 5 Sep 2018 10:30:28 +0100 Subject: [PATCH] Update documentation Update documentation with new API for Output Processors which includes the context in the intialize and finalize methods. --- .../developer_information/developer_guide/writing_plugins.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/developer_information/developer_guide/writing_plugins.rst b/doc/source/developer_information/developer_guide/writing_plugins.rst index 6abe127c..0b684c22 100644 --- a/doc/source/developer_information/developer_guide/writing_plugins.rst +++ b/doc/source/developer_information/developer_guide/writing_plugins.rst @@ -343,7 +343,7 @@ see the A list of additional :class:`Parameters` the output processor can take. - :initialize(): + :initialize(context): This method will only be called once during the workload run therefore operations that only need to be performed initially should @@ -373,7 +373,7 @@ see the existing data collected/generated for the run as a whole. E.g. uploading them to a database etc. - :finalize(): + :finalize(context): This method is the complement to the initialize method and will also only be called once.