From f6f9daec35ce7484c13330e7e4156f97a5e2be0c Mon Sep 17 00:00:00 2001 From: "Josh.5" Date: Sat, 7 May 2022 12:35:10 +1200 Subject: [PATCH] Add missing params to on_postprocessor_task_results docs --- docs/development/writing_plugins/plugin_runner_types.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/development/writing_plugins/plugin_runner_types.mdx b/docs/development/writing_plugins/plugin_runner_types.mdx index cb6ab70..8f2602d 100644 --- a/docs/development/writing_plugins/plugin_runner_types.mdx +++ b/docs/development/writing_plugins/plugin_runner_types.mdx @@ -243,6 +243,8 @@ Just prior to the task cache directory cleanup. `on_postprocessor_task_results(data)` ##### Provided data: + - **`final_cache_path`** *[string]* - The path to the final cache file that was then used as the source for all destination files. + - **`library_id`** *[integer]* - The library that the current task is associated with. - **`task_processing_success`** *[boolean]* - Specifies if all task processes complete successfully. - **`file_move_processes_success`** *[boolean]* - Specifies if all postprocessor movement tasks complete successfully. - **`destination_files`** *[list]* - All file paths created by postprocessor file movements. @@ -261,6 +263,8 @@ def on_postprocessor_task_results(data): Runner function - provides a means for additional postprocessor functions based on the task success. The 'data' object argument includes: + final_cache_path - The path to the final cache file that was then used as the source for all destination files. + library_id - The library that the current task is associated with. task_processing_success - Boolean, did all task processes complete successfully. file_move_processes_success - Boolean, did all postprocessor movement tasks complete successfully. destination_files - List containing all file paths created by postprocessor file movements.