This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new a755c5e82b Expose missing params in AzureSynapseHook API docs (#30099)
a755c5e82b is described below
commit a755c5e82b5c0c673b2278220b55150e6dd743c0
Author: Josh Fell <[email protected]>
AuthorDate: Wed Mar 15 05:33:45 2023 -0400
Expose missing params in AzureSynapseHook API docs (#30099)
Poor formatting of some method docstrings where hiding parameters from
being properly rendered in the Python API docs for AzureSynapseHook.
---
airflow/providers/microsoft/azure/hooks/synapse.py | 2 ++
1 file changed, 2 insertions(+)
diff --git a/airflow/providers/microsoft/azure/hooks/synapse.py
b/airflow/providers/microsoft/azure/hooks/synapse.py
index a1d9ec162c..8d1aed2afb 100644
--- a/airflow/providers/microsoft/azure/hooks/synapse.py
+++ b/airflow/providers/microsoft/azure/hooks/synapse.py
@@ -140,6 +140,7 @@ class AzureSynapseHook(BaseHook):
):
"""
Run a job in an Apache Spark pool.
+
:param payload: Livy compatible payload which represents the spark job
that a user wants to submit.
"""
job = self.get_conn().spark_batch.create_spark_batch_job(payload)
@@ -196,6 +197,7 @@ class AzureSynapseHook(BaseHook):
) -> None:
"""
Cancel the spark job run.
+
:param job_id: The synapse spark job identifier.
"""
self.get_conn().spark_batch.cancel_spark_batch_job(job_id)
