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

Update deferring.rst #38122

Merged
merged 2 commits into from Mar 15, 2024
Merged

Update deferring.rst #38122

merged 2 commits into from Mar 15, 2024

Conversation

9uzman7
Copy link
Contributor

@9uzman7 9uzman7 commented Mar 13, 2024

It took me a long time to figure out that context: Context should also be in the method_name signature. I vaguely updated the docs, but it would be nice to add somewhere that context should be part of method_name signature


^ 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.

Copy link

boring-cyborg bot commented Mar 13, 2024

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

Copy link
Member

@potiuk potiuk left a comment

Choose a reason for hiding this comment

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

It's in all the examples above and below so I think just explicitly mentioning it is ok.

@uranusjr
Copy link
Member

I think the context argument was taken for granted because it is also given to execute, and only event is “added” to subsequent methods. Maybe we should mention execute here to make it more explicit.

@9uzman7
Copy link
Contributor Author

9uzman7 commented Mar 14, 2024

I think the context argument was taken for granted because it is also given to execute, and only event is “added” to subsequent methods. Maybe we should mention execute here to make it more explicit.

that was what took to me to think that context was in the example, because the example is execute_complete which execute takes context, so it made sense to keep using context 🙃

@9uzman7
Copy link
Contributor Author

9uzman7 commented Mar 15, 2024

@dirrao @pankajastro thanks for the approvals! not sure who can merge this in

@potiuk potiuk merged commit bbb03a7 into apache:main Mar 15, 2024
49 checks passed
Copy link

boring-cyborg bot commented Mar 15, 2024

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

@ephraimbuddy ephraimbuddy added the changelog:skip Changes that should be skipped from the changelog (CI, tests, etc..) label Mar 18, 2024
@jedcunningham jedcunningham added this to the Airflow 2.8.4 milestone Mar 19, 2024
@jedcunningham jedcunningham added type:doc-only Changelog: Doc Only and removed changelog:skip Changes that should be skipped from the changelog (CI, tests, etc..) labels Mar 19, 2024
jedcunningham pushed a commit that referenced this pull request Mar 19, 2024
(cherry picked from commit bbb03a7)
utkarsharma2 pushed a commit to astronomer/airflow that referenced this pull request Apr 22, 2024
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

7 participants