Jakob Homan created AIRFLOW-5491:
------------------------------------

             Summary: 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


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)

Reply via email to