Skip to content

Commit

Permalink
Add missing params to on_postprocessor_task_results docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Josh5 committed May 7, 2022
1 parent c8d8c4c commit f6f9dae
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/development/writing_plugins/plugin_runner_types.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down

0 comments on commit f6f9dae

Please sign in to comment.