Skip to content

Fix BranchPythonOperator documentation #54205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eladkal merged 1 commit into from
Aug 7, 2025
Merged

Fix BranchPythonOperator documentation #54205

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions providers/standard/docs/operators/python.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,16 +298,16 @@ Templating
Jinja templating can be used in same way as described for the :ref:`howto/operator:PythonOperator`.


.. _howto/operator:PythonBranchOperator:
.. _howto/operator:BranchPythonOperator:

PythonBranchOperator
BranchPythonOperator
====================

Use the :class:`~airflow.providers.standard.operators.python.PythonBranchOperator` to execute Python :ref:`branching <concepts:branching>`
Use the :class:`~airflow.providers.standard.operators.python.BranchPythonOperator` to execute Python :ref:`branching <concepts:branching>`
tasks.

.. tip::
The ``@task.branch`` decorator is recommended over the classic ``PythonBranchOperator``
The ``@task.branch`` decorator is recommended over the classic ``BranchPythonOperator``
to execute Python code.

.. tab-set::
Expand All @@ -321,7 +321,7 @@ tasks.
:start-after: [START howto_operator_branch_python]
:end-before: [END howto_operator_branch_python]

.. tab-item:: PythonBranchOperator
.. tab-item:: BranchPythonOperator
:sync: operator

.. exampleinclude:: /../src/airflow/providers/standard/example_dags/example_branch_operator.py
Expand All @@ -341,7 +341,7 @@ BranchPythonVirtualenvOperator
==============================

Use the :class:`~airflow.providers.standard.operators.python.BranchPythonVirtualenvOperator` decorator to execute Python :ref:`branching <concepts:branching>`
tasks and is a hybrid of the :class:`~airflow.providers.standard.operators.python.PythonBranchOperator` with execution in a virtual environment.
tasks and is a hybrid of the :class:`~airflow.providers.standard.operators.python.BranchPythonOperator` with execution in a virtual environment.

.. tip::
The ``@task.branch_virtualenv`` decorator is recommended over the classic
Expand Down Expand Up @@ -378,7 +378,7 @@ BranchExternalPythonOperator
============================

Use the :class:`~airflow.providers.standard.operators.python.BranchExternalPythonOperator` to execute Python :ref:`branching <concepts:branching>`
tasks and is a hybrid of the :class:`~airflow.providers.standard.operators.python.PythonBranchOperator` with execution in an
tasks and is a hybrid of the :class:`~airflow.providers.standard.operators.python.BranchPythonOperator` with execution in an
external Python environment.

.. tip::
Expand Down
Loading