uranusjr commented on a change in pull request #19723:
URL: https://github.com/apache/airflow/pull/19723#discussion_r753759296
##########
File path: airflow/providers/databricks/hooks/databricks.py
##########
@@ -400,7 +402,13 @@ def get_job_id(self, run_id: str) -> str:
def get_run_state(self, run_id: str) -> RunState:
"""
- Retrieves run state of the run.
+ Retrieves run state of the run. Please note that any Airflow tasks
that call the `get_run_state`
Review comment:
```suggestion
"""Retrieves run state of the run.
Please note that any Airflow tasks that call the `get_run_state`
```
https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings
> Multi-line docstrings consist of a summary line just like a one-line
docstring, followed by a blank line, followed by a more elaborate description.
##########
File path: airflow/providers/databricks/hooks/databricks.py
##########
@@ -400,7 +402,13 @@ def get_job_id(self, run_id: str) -> str:
def get_run_state(self, run_id: str) -> RunState:
"""
- Retrieves run state of the run.
+ Retrieves run state of the run. Please note that any Airflow tasks
that call the `get_run_state`
Review comment:
Also restructuredText requires code to use double ticks, not single.
##########
File path: airflow/providers/databricks/hooks/databricks.py
##########
@@ -400,7 +402,13 @@ def get_job_id(self, run_id: str) -> str:
def get_run_state(self, run_id: str) -> RunState:
"""
- Retrieves run state of the run.
+ Retrieves run state of the run. Please note that any Airflow tasks
that call the `get_run_state`
Review comment:
```suggestion
"""Retrieves run state of the run.
Please note that any Airflow tasks that call the ``get_run_state``
```
https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings
> Multi-line docstrings consist of a summary line just like a one-line
docstring, followed by a blank line, followed by a more elaborate description.
##########
File path: airflow/providers/databricks/hooks/databricks.py
##########
@@ -400,7 +402,13 @@ def get_job_id(self, run_id: str) -> str:
def get_run_state(self, run_id: str) -> RunState:
"""
- Retrieves run state of the run.
+ Retrieves run state of the run. Please note that any Airflow tasks
that call the `get_run_state`
Review comment:
Also restructuredText requires code to use double ticks, not single.
Please fix all the code blocks below as well.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
