Update wait_for_event documentation

[adrianlyjak]

Update wait_for_event documentation to clarify its exception-and-replay behavior.

The runtime pauses by throwing an internal control-flow exception and replays the entire step when the event arrives, so callers should keep the wait near the start of the step and ensure any preceding logic is safe to repeat.

---

Linear Issue: LI-4105

 

[cursor]

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
_{Learn more about Cursor Agents}

[changeset-bot]

⚠️ No Changeset found

Latest commit: 15a63be

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR