You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2021/04/18 04:23:08 UTC
[GitHub] [airflow] 0eu opened a new pull request #15417: Fix formatting issue in tutorial_taskflow_api documentation
0eu opened a new pull request #15417:
URL: https://github.com/apache/airflow/pull/15417
Round brackets after `@task` decorator breaks page formatting: `def extract_from_file` is aligned with function's body [2 level], not a decorator [1 level].
Now it looks like:
```python
@task()
def extract_from_file():
"""
#### Extract from file task
A simple Extract task to get data ready for the rest of the data
pipeline, by reading the data from a file into a pandas dataframe
"""
```
but should:
```python
@task()
def extract_from_file():
"""
#### Extract from file task
A simple Extract task to get data ready for the rest of the data
pipeline, by reading the data from a file into a pandas dataframe
"""
```
Page is right here: [https://airflow.apache.org/docs/apache-airflow/stable/tutorial_taskflow_api.html](tutorial taskflow api).
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#pull-request-guidelines)** for more information.
In case of fundamental code change, Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in [UPDATING.md](https://github.com/apache/airflow/blob/master/UPDATING.md).
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] uranusjr commented on pull request #15417: Fix formatting issue in tutorial_taskflow_api documentation
Posted by GitBox <gi...@apache.org>.
uranusjr commented on pull request #15417:
URL: https://github.com/apache/airflow/pull/15417#issuecomment-823542351
> Round brackets after `@task` decorator breaks page formatting
Do you know why this happens? I feel we should fix whatever causes it instead of just avoid the bug.
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] eladkal closed pull request #15417: Fix formatting issue in tutorial_taskflow_api documentation
Posted by GitBox <gi...@apache.org>.
eladkal closed pull request #15417:
URL: https://github.com/apache/airflow/pull/15417
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] eladkal edited a comment on pull request #15417: Fix formatting issue in tutorial_taskflow_api documentation
Posted by GitBox <gi...@apache.org>.
eladkal edited a comment on pull request #15417:
URL: https://github.com/apache/airflow/pull/15417#issuecomment-846961606
I think this is fixed in https://github.com/apache/airflow/pull/14241
In any case the doc looks fine now so I'm closing this PR
2.0.1:

2.1.0:

--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] boring-cyborg[bot] commented on pull request #15417: Fix formatting issue in tutorial_taskflow_api documentation
Posted by GitBox <gi...@apache.org>.
boring-cyborg[bot] commented on pull request #15417:
URL: https://github.com/apache/airflow/pull/15417#issuecomment-821929997
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/master/CONTRIBUTING.rst)
Here are some useful points:
- Pay attention to the quality of your code (flake8, pylint and type annotations). Our [pre-commits]( https://github.com/apache/airflow/blob/master/STATIC_CODE_CHECKS.rst#prerequisites-for-pre-commit-hooks) 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](https://github.com/apache/airflow/blob/master/docs/apache-airflow/howto/custom-operator.rst) Consider adding an example DAG that shows how users should use it.
- Consider using [Breeze environment](https://github.com/apache/airflow/blob/master/BREEZE.rst) 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](https://www.apache.org/foundation/policies/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]( https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#coding-style-and-best-practices).
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
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] eladkal commented on pull request #15417: Fix formatting issue in tutorial_taskflow_api documentation
Posted by GitBox <gi...@apache.org>.
eladkal commented on pull request #15417:
URL: https://github.com/apache/airflow/pull/15417#issuecomment-846961606
fixed in https://github.com/apache/airflow/pull/14241
2.0.1:

2.1.0:

--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org