Add note to orderSequentially that it may enter staging mode #24886
+3
−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.
The
orderSequentially
function may enter staging mode for the duration of the call. Because of this, an error will be thrown if a user tries to enter staging mode in the callback provided toorderSequentially
. The error's message is"Already in staging mode"
, and could be confusing from the end user's perspective as they never entered staging mode themselves.See #24728 (comment)
Example: