Updated docstrings

Signed-off-by: Elena Khaustova <ymax70rus@gmail.com>
kedro-org · Sep 13, 2024 · 78feb51 · 78feb51
1 parent 741b682
commit 78feb51
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 11 deletions.
diff --git a/kedro/framework/hooks/specs.py b/kedro/framework/hooks/specs.py
@@ -63,7 +63,7 @@ def before_node_run(
 
         Args:
             node: The ``Node`` to run.
-            catalog: A catalog containing the node's inputs and outputs.
+            catalog: An implemented instance of ``CatalogProtocol`` containing the node's inputs and outputs.
             inputs: The dictionary of inputs dataset.
                 The keys are dataset names and the values are the actual loaded input data,
                 not the dataset instance.
@@ -93,7 +93,7 @@ def after_node_run(  # noqa: PLR0913
 
         Args:
             node: The ``Node`` that ran.
-            catalog: A catalog containing the node's inputs and outputs.
+            catalog: An implemented instance of ``CatalogProtocol`` containing the node's inputs and outputs.
             inputs: The dictionary of inputs dataset.
                 The keys are dataset names and the values are the actual loaded input data,
                 not the dataset instance.
@@ -122,7 +122,7 @@ def on_node_error(  # noqa: PLR0913
         Args:
             error: The uncaught exception thrown during the node run.
             node: The ``Node`` to run.
-            catalog: A catalog containing the node's inputs and outputs.
+            catalog: An implemented instance of ``CatalogProtocol`` containing the node's inputs and outputs.
             inputs: The dictionary of inputs dataset.
                 The keys are dataset names and the values are the actual loaded input data,
                 not the dataset instance.

diff --git a/kedro/runner/parallel_runner.py b/kedro/runner/parallel_runner.py
@@ -73,7 +73,7 @@ def _run_node_synchronization(  # noqa: PLR0913
 
     Args:
         node: The ``Node`` to run.
-        catalog: A catalog containing the node's inputs and outputs.
+        catalog: An implemented instance of ``CatalogProtocol`` containing the node's inputs and outputs.
         is_async: If True, the node inputs and outputs are loaded and saved
             asynchronously with threads. Defaults to False.
         session_id: The session id of the pipeline run.

diff --git a/kedro/runner/runner.py b/kedro/runner/runner.py
@@ -68,7 +68,7 @@ def run(
 
         Args:
             pipeline: The ``Pipeline`` to run.
-            catalog: The catalog from which to fetch data.
+            catalog: An implemented instance of ``CatalogProtocol`` from which to fetch data.
             hook_manager: The ``PluginManager`` to activate hooks.
             session_id: The id of the session.
 
@@ -132,7 +132,7 @@ def run_only_missing(
 
         Args:
             pipeline: The ``Pipeline`` to run.
-            catalog: The catalog from which to fetch data.
+            catalog: An implemented instance of ``CatalogProtocol`` from which to fetch data.
             hook_manager: The ``PluginManager`` to activate hooks.
         Raises:
             ValueError: Raised when ``Pipeline`` inputs cannot be
@@ -173,7 +173,7 @@ def _run(
 
         Args:
             pipeline: The ``Pipeline`` to run.
-            catalog: The `catalog from which to fetch data.
+            catalog: An implemented instance of ``CatalogProtocol`` from which to fetch data.
             hook_manager: The ``PluginManager`` to activate hooks.
             session_id: The id of the session.
 
@@ -194,7 +194,7 @@ def _suggest_resume_scenario(
         Args:
             pipeline: the ``Pipeline`` of the run.
             done_nodes: the ``Node``s that executed successfully.
-            catalog: the catalog of the run.
+            catalog: an implemented instance of ``CatalogProtocol`` of the run.
 
         """
         remaining_nodes = set(pipeline.nodes) - set(done_nodes)
@@ -388,7 +388,7 @@ def run_node(
 
     Args:
         node: The ``Node`` to run.
-        catalog: A catalog containing the node's inputs and outputs.
+        catalog: An implemented instance of ``CatalogProtocol`` containing the node's inputs and outputs.
         hook_manager: The ``PluginManager`` to activate hooks.
         is_async: If True, the node inputs and outputs are loaded and saved
             asynchronously with threads. Defaults to False.

diff --git a/kedro/runner/sequential_runner.py b/kedro/runner/sequential_runner.py
@@ -56,7 +56,7 @@ def _run(
 
         Args:
             pipeline: The ``Pipeline`` to run.
-            catalog: The catalog from which to fetch data.
+            catalog: An implemented instance of ``CatalogProtocol`` from which to fetch data.
             hook_manager: The ``PluginManager`` to activate hooks.
             session_id: The id of the session.
 

diff --git a/kedro/runner/thread_runner.py b/kedro/runner/thread_runner.py
@@ -95,7 +95,7 @@ def _run(
 
         Args:
             pipeline: The ``Pipeline`` to run.
-            catalog: The catalog from which to fetch data.
+            catalog: An implemented instance of ``CatalogProtocol`` from which to fetch data.
             hook_manager: The ``PluginManager`` to activate hooks.
             session_id: The id of the session.