Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing BashOperator import to documentation example #31436

Merged
merged 4 commits into from
May 22, 2023

Conversation

tadeha
Copy link
Contributor

@tadeha tadeha commented May 20, 2023


This pull request addresses an issue in the Airflow documentation where the BashOperator was used in a code example but not imported. To provide a more accurate and complete example for users, the necessary import statement has been added.

This change ensures that users who reference this example will have a fully functional code snippet that includes the necessary import for the BashOperator. This will help prevent confusion and potential errors when users attempt to implement the example in their projects.

@boring-cyborg
Copy link

boring-cyborg bot commented May 20, 2023

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 Contribution Guide (https://github.com/apache/airflow/blob/main/CONTRIBUTING.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.
    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

tadeha and others added 2 commits May 22, 2023 13:44
Co-authored-by: Ephraim Anierobi <splendidzigy24@gmail.com>
@eladkal eladkal added this to the Airflow 2.6.2 milestone May 22, 2023
@eladkal eladkal added the type:doc-only Changelog: Doc Only label May 22, 2023
@ephraimbuddy ephraimbuddy merged commit 1ac35e7 into apache:main May 22, 2023
42 checks passed
@boring-cyborg
Copy link

boring-cyborg bot commented May 22, 2023

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

eladkal pushed a commit that referenced this pull request Jun 8, 2023
* Update notifications.rst with importing BashOperator in the example.

* Sort imports

* Update docs/apache-airflow/howto/notifications.rst

Co-authored-by: Ephraim Anierobi <splendidzigy24@gmail.com>

---------

Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
Co-authored-by: Ephraim Anierobi <splendidzigy24@gmail.com>
(cherry picked from commit 1ac35e7)
eladkal pushed a commit that referenced this pull request Jun 9, 2023
* Update notifications.rst with importing BashOperator in the example.

* Sort imports

* Update docs/apache-airflow/howto/notifications.rst

Co-authored-by: Ephraim Anierobi <splendidzigy24@gmail.com>

---------

Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
Co-authored-by: Ephraim Anierobi <splendidzigy24@gmail.com>
(cherry picked from commit 1ac35e7)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants