From 3839da166dd6bbcc10595aea008f4db996101350 Mon Sep 17 00:00:00 2001 From: Marc Bonnici Date: Mon, 4 Jun 2018 17:27:22 +0100 Subject: [PATCH] doc: Fix instrument documentation Fixed outdated `update_results` method references. --- doc/source/developer_reference/writing_plugins.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/source/developer_reference/writing_plugins.rst b/doc/source/developer_reference/writing_plugins.rst index 91b539fc..d3e058c6 100644 --- a/doc/source/developer_reference/writing_plugins.rst +++ b/doc/source/developer_reference/writing_plugins.rst @@ -884,7 +884,7 @@ The full interface of WA instruments is shown below:: def setup(self, context): """ This method is invoked after the workload is setup. All the - necessary setups should go inside this method. Setup, includes + necessary setup should go inside this method. Setup, includes operations like clearing logs, additional configuration etc. """ pass @@ -903,7 +903,7 @@ The full interface of WA instruments is shown below:: """ pass - def update_result(self, context): + def update_output(self, context): """ It is invoked after the workload updated its result. update_result is where the taken measures are added to the result so it @@ -1008,7 +1008,7 @@ Below is a simple instrument that measures the execution time of a workload:: def stop(self, context): self.end_time = time.time() - def update_result(self, context): + def update_output(self, context): execution_time = self.end_time - self.start_time context.add_metric('execution_time', execution_time, 'seconds')