-
Notifications
You must be signed in to change notification settings - Fork 2.7k
docs: clarify auto-variadic socket input ordering in connect() #11053
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
Merged
+18
−0
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
a160b45
docs: clarify auto-variadic socket input ordering in connect()
saivedant169 b390210
docs: clarify Pipeline vs AsyncPipeline variadic ordering
saivedant169 6a9065f
docs: apply review feedback on connect() variadic docstring
saivedant169 65b25f6
Apply suggestion from @sjrl
sjrl File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
12 changes: 12 additions & 0 deletions
12
releasenotes/notes/document-variadic-input-ordering-530d8feee4a1b900.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| enhancements: | ||
| - | | ||
| Document the input ordering behavior of auto-promoted lazy variadic sockets in | ||
| ``Pipeline.connect()``. When | ||
| multiple senders are connected to the same list-typed receiver socket, ordering | ||
| depends on the pipeline class. With ``Pipeline``, items are ordered alphabetically | ||
| by sender component name (because ``Pipeline.run()`` schedules components in | ||
| alphabetical order for deterministic execution), not by the order of ``connect()`` | ||
| calls. With ``AsyncPipeline``, no ordering is guaranteed, since components in | ||
| different branches may run in parallel. The docstrings now point users to a | ||
| dedicated joiner component when they need explicit ordering. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.