-
Notifications
You must be signed in to change notification settings - Fork 14.6k
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.
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
update xcom docs #46284
base: main
Are you sure you want to change the base?
update xcom docs #46284
Conversation
When pushing multiple XCom values, we can still pull them using the 'return_value' key if we aren't explicitly pushing using a new key. So, we aren't exactly renaming anything here. Rather, we can now also pull using the keys within the returned XCom dictionary. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might be helpful to add a code snippet here demonstrating what you mean. Just by reading this, I'd have no idea how to actually implement this.
It would also probably be helpful to add additional context as to why someone would want to push multiple xcoms
@@ -52,7 +52,7 @@ You can also use XComs in :ref:`templates <concepts:jinja-templating>`:: | |||
|
|||
XComs are a relative of :doc:`variables`, with the main difference being that XComs are per-task-instance and designed for communication within a DAG run, while Variables are global and designed for overall configuration and value sharing. | |||
|
|||
If you want to push multiple XComs at once or rename the pushed XCom key, you can use set ``do_xcom_push`` and ``multiple_outputs`` arguments to ``True``, and then return a dictionary of values. | |||
If you want to push multiple XComs at once you can set ``do_xcom_push`` and ``multiple_outputs`` arguments to ``True``, and then return a dictionary of values. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you want to push multiple XComs at once you can set ``do_xcom_push`` and ``multiple_outputs`` arguments to ``True``, and then return a dictionary of values. | |
If you want to push multiple XComs at once, you can set ``do_xcom_push`` and ``multiple_outputs`` arguments to ``True``. This will return a dictionary of values. |
minor rewrite of the sentence regarding pushing of multiple XComs