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.
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.
🚩 Pre-existing doc code errors in childTask1 and childTask2 examples
The example code for
childTask1andchildTask2(shared across thebatch.triggerAndWaitandbatch.triggerByTasksections) contains bugs that would produce incorrect runtime behavior if a user copied them:docs/triggering.mdx:565,childTask1doesreturn \Hello ${payload}`wherepayloadis{ foo: string }. This would stringify toHello [object Object]instead of the likely intendedHello ${payload.foo}`.docs/triggering.mdx:572,childTask2references a barebarvariable (return bar + 1) which is not in scope — the parameter ispayload: { bar: number }, so it should bereturn payload.bar + 1.These same errors are repeated in the
batch.triggerByTasksection at lines 601 and 608. These are pre-existing issues not introduced by this PR, but they could mislead users copying the examples.(Refers to lines 562-574)
Was this helpful? React with 👍 or 👎 to provide feedback.