Skip to content

Update documentation priority weight#47529

Merged
shahar1 merged 14 commits intoapache:mainfrom
azharizz:main
Mar 10, 2025
Merged

Update documentation priority weight#47529
shahar1 merged 14 commits intoapache:mainfrom
azharizz:main

Conversation

@azharizz
Copy link
Contributor

@azharizz azharizz commented Mar 8, 2025


closes: #46824
link

I have already tried the custom weight rule on my local environment, and it is applicable. However, the code block inside it is not the same as the code above. So i try to fix it with add some command airflow plugins to see list plugin created.

@boring-cyborg
Copy link

boring-cyborg bot commented Mar 8, 2025

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
Contributor

@jscheffl jscheffl left a comment

Choose a reason for hiding this comment

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

Thanks for the improvement in docs!

@eladkal
Copy link
Contributor

eladkal commented Mar 8, 2025

@ninsbl reported on the issue that is possibly a bug rather than just a doc update. Is that still the case?

@jscheffl
Copy link
Contributor

jscheffl commented Mar 8, 2025

For me the change is okay. To be on the safe side... one improvement idea: Can you add the code snippet rather as a new example DAG (e.g. name it example_custom_weight.py)? Then you can change the RST to include the code snippet and when loading Airflow with example DAGs you can see how it is working.

In the past such example DAG was not added because plugins/extensions were not loaded by default, but this has changed since then. So adding an example DAG might be a good option nowadays.

@azharizz
Copy link
Contributor Author

azharizz commented Mar 9, 2025

sure @jscheffl , i already update the code to add example dags. Also for the test on the dag and documentation using breeze there is no issue regarding this custom weight rule

@azharizz
Copy link
Contributor Author

azharizz commented Mar 9, 2025

thanks for the review @jscheffl , i have changed the code

@shahar1 shahar1 merged commit febd233 into apache:main Mar 10, 2025
2 checks passed
@boring-cyborg
Copy link

boring-cyborg bot commented Mar 10, 2025

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

@ninsbl
Copy link
Contributor

ninsbl commented Mar 10, 2025

Nice. Thanks, @azharizz !

nailo2c pushed a commit to nailo2c/airflow that referenced this pull request Apr 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Priority Weights: Examples are not reproducible

Comments