Skip to content

Commit

Permalink
Update specs in pipeline hooks docstrings (#2598)
Browse files Browse the repository at this point in the history
* Update pipeline hooks docstrings

Signed-off-by: Tomas Van Pottelbergh <github@tomasvanpottelbergh.com>

* Acknowledge community contribution

---------

Signed-off-by: Tomas Van Pottelbergh <github@tomasvanpottelbergh.com>
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
  • Loading branch information
3 people authored May 22, 2023
1 parent dc14f24 commit 2c9fb4b
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
6 changes: 6 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@

## Breaking changes to the API
* `kedro package` does not produce `.egg` files anymore, and now relies exclusively on `.whl` files.

## Community contributions
Many thanks to the following Kedroids for contributing PRs to this release:

* [tomasvanpottelbergh](https://github.com/tomasvanpottelbergh)

## Upcoming deprecations for Kedro 0.19.0


Expand Down
13 changes: 10 additions & 3 deletions kedro/framework/hooks/specs.py
Original file line number Diff line number Diff line change
Expand Up @@ -155,8 +155,10 @@ def before_pipeline_run(
"from_inputs": Optional[List[str]],
"to_outputs": Optional[List[str]],
"load_versions": Optional[List[str]],
"pipeline_name": str,
"extra_params": Optional[Dict[str, Any]]
"pipeline_name": str,
"namespace": Optional[str],
"runner": str,
}
pipeline: The ``Pipeline`` that will be run.
Expand Down Expand Up @@ -190,8 +192,10 @@ def after_pipeline_run(
"from_inputs": Optional[List[str]],
"to_outputs": Optional[List[str]],
"load_versions": Optional[List[str]],
"pipeline_name": str,
"extra_params": Optional[Dict[str, Any]]
"pipeline_name": str,
"namespace": Optional[str],
"runner": str,
}
run_result: The output of ``Pipeline`` run.
Expand Down Expand Up @@ -229,9 +233,12 @@ def on_pipeline_error(
"from_inputs": Optional[List[str]],
"to_outputs": Optional[List[str]],
"load_versions": Optional[List[str]],
"pipeline_name": str,
"extra_params": Optional[Dict[str, Any]]
"pipeline_name": str,
"namespace": Optional[str],
"runner": str,
}
pipeline: The ``Pipeline`` that will was run.
catalog: The ``DataCatalog`` used during the run.
"""
Expand Down

0 comments on commit 2c9fb4b

Please sign in to comment.