[jira] [Commented] (AIRFLOW-5491) mark_tasks pydoc is incorrect

["ASF GitHub Bot (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/AIRFLOW-5491?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16930106#comment-16930106 ] 

ASF GitHub Bot commented on AIRFLOW-5491:
-----------------------------------------

Mordeck commented on pull request #6108: [AIRFLOW-5491] mark_tasks pydoc is incorrect
URL: https://github.com/apache/airflow/pull/6108
 
 
   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   - [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
     - https://issues.apache.org/jira/browse/AIRFLOW-XXX
     - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
     - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
     - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
   
   ### Description
   
   - [ ] Here are some details about my PR, including screenshots of any UI changes:
   
   ### Tests
   
   - [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
   
   ### Commits
   
   - [ ] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)":
     1. Subject is separated from body by a blank line
     1. Subject is limited to 50 characters (not including Jira issue reference)
     1. Subject does not end with a period
     1. Subject uses the imperative mood ("add", not "adding")
     1. Body wraps at 72 characters
     1. Body explains "what" and "why", not "how"
   
   ### Documentation
   
   - [ ] In case of new functionality, my PR adds documentation that describes how to use it.
     - All the public functions and the classes in the PR contain docstrings that explain what it does
     - If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
   
 
----------------------------------------------------------------
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


> mark_tasks pydoc is incorrect
> -----------------------------
>
>                 Key: AIRFLOW-5491
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-5491
>             Project: Apache Airflow
>          Issue Type: Bug
>          Components: security
>    Affects Versions: 1.10.6
>            Reporter: Jakob Homan
>            Priority: Minor
>              Labels: ccoss2019, newbie
>
> Note: This ticket's being created to facilitate a new contributor's workshop for Airflow. After the workshop has completed, I'll mark these all available for anyone that might like to take them on.
> The pydoc for set_state is incorrect; it thinks the first param named {{task instead of }}{{tasks}} (which is used in the code, and the doc itself thinks this is a single task instead of an iterable.
> airflow/api/common/experimental/mark_tasks.py:62
> {code:java}
> def set_state(
>         tasks: Iterable[BaseOperator],
>         execution_date: datetime.datetime,
>         upstream: bool = False,
>         downstream: bool = False,
>         future: bool = False,
>         past: bool = False,
>         state: str = State.SUCCESS,
>         commit: bool = False,
>         session=None):  # pylint: disable=too-many-arguments,too-many-locals
>     """
>     Set the state of a task instance and if needed its relatives. Can set state
>     for future tasks (calculated from execution_date) and retroactively
>     for past tasks. Will verify integrity of past dag runs in order to create
>     tasks that did not exist. It will not create dag runs that are missing
>     on the schedule (but it will as for subdag dag runs if needed).
>     :param task: the task from which to work. task.task.dag needs to be set {code}



--
This message was sent by Atlassian Jira
(v8.3.2#803003)