Skip to content

Remove reference to execution_info in snowflake hook docstring - #37804

Merged
potiuk merged 1 commit into
apache:mainfrom
remisalmon:fix-snowflake-hook-doc
Mar 1, 2024
Merged

potiuk merged 1 commit into
apache:mainfrom
remisalmon:fix-snowflake-hook-doc

Conversation

@remisalmon

Copy link
Copy Markdown
Contributor

This is clearing up the snowflake hook run function docstring that reference a variable that is not returned or used at all in the snowflake provider:

> git grep execution_info
airflow/providers/microsoft/azure/hooks/batch.py:                    if task.execution_info.result == batch_models.TaskExecutionResult.failure
tests/providers/microsoft/azure/hooks/test_batch.py:                    execution_info=batch_models.TaskExecutionInformation(
tests/providers/microsoft/azure/hooks/test_batch.py:                    execution_info=batch_models.TaskExecutionInformation(
tests/providers/microsoft/azure/hooks/test_batch.py:                execution_info=batch_models.TaskExecutionInformation(
tests/providers/microsoft/azure/hooks/test_batch.py:                execution_info=batch_models.TaskExecutionInformation(

^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

@boring-cyborg boring-cyborg Bot added area:providers provider:snowflake Issues related to Snowflake provider labels Feb 29, 2024
@boring-cyborg

boring-cyborg Bot commented Feb 29, 2024

Copy link
Copy Markdown

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our pre-commits will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@dirrao dirrao left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@potiuk
potiuk merged commit 9dac90a into apache:main Mar 1, 2024
@boring-cyborg

boring-cyborg Bot commented Mar 1, 2024

Copy link
Copy Markdown

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

@potiuk

potiuk commented Mar 1, 2024

Copy link
Copy Markdown
Member

Nice!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:providers provider:snowflake Issues related to Snowflake provider

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants