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/11/14 11:06:30 UTC
[GitHub] [airflow] khalidmammadov opened a new pull request #19580: Improve documentation for tasks run command
khalidmammadov opened a new pull request #19580:
URL: https://github.com/apache/airflow/pull/19580
Current documentation is just an one line and does not elaborate it's intent or usage guide. So, for example if we run it for a brand new dag with no run history it exits with error log about the same. I thought it would be better to provide the same in the documentation guide so to avoid disappointment for the end user.
Feel free to to suggest any other/additional wording that might be useful.
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/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/main/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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] uranusjr commented on a change in pull request #19580: Improve documentation for tasks run command
Posted by GitBox <gi...@apache.org>.
uranusjr commented on a change in pull request #19580:
URL: https://github.com/apache/airflow/pull/19580#discussion_r748847593
##########
File path: airflow/cli/commands/task_command.py
##########
@@ -228,7 +228,11 @@ def _capture_task_logs(ti):
@cli_utils.action_logging
def task_run(args, dag=None):
- """Runs a single task instance"""
+ """Runs a single task instance.
+ Note that there must be at least one DagRun for this to start.
+ i.e. it must have been scheduled and/or triggered previously.
+ Alternatively, if you just need to run it for testing then use "airflow tasks test ..." command instead
+ """
Review comment:
```suggestion
"""Run a single task instance.
Note that there must be at least one DagRun for this to start,
i.e. it must have been scheduled and/or triggered previously.
Alternatively, if you just need to run it for testing then use
"airflow tasks test ..." command instead.
"""
```
Following conventional Python docstring styles.
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] uranusjr merged pull request #19580: Improve documentation for tasks run command
Posted by GitBox <gi...@apache.org>.
uranusjr merged pull request #19580:
URL: https://github.com/apache/airflow/pull/19580
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] github-actions[bot] commented on pull request #19580: Improve documentation for tasks run command
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #19580:
URL: https://github.com/apache/airflow/pull/19580#issuecomment-968345528
The PR is likely OK to be merged with just subset of tests for default Python and Database versions without running the full matrix of tests, because it does not modify the core of Airflow. If the committers decide that the full tests matrix is needed, they will add the label 'full tests needed'. Then you should rebase to the latest main or amend the last commit of the PR, and push it with --force-with-lease.
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org