Add text to debug doc about multiple invocations #5225
Merged
+4
−0
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.
What's Changing
Disclosing out-of-order output expectations in the
debug
operator docs.Why
When doing final verification of the
debug
operator, I revisited the recreation of thejq
example shown in #5181 and noticed something for the first time in our implementation: Whereasjq
's debug outputs always appear in the relative order that matches their appearance in the pipeline:In our equivalent, the order of the debug outputs can vary. I understand this to be an expected side effect of our implementation, but I also expect this might look like a bug to some users, so I figure a disclosure might help.