docs: Update outdated design and API documentation#327
Open
ayushiahjolia wants to merge 1 commit intomainfrom
Open
docs: Update outdated design and API documentation#327ayushiahjolia wants to merge 1 commit intomainfrom
ayushiahjolia wants to merge 1 commit intomainfrom
Conversation
zhongkechen
approved these changes
Apr 10, 2026
| └── ChildContextFailedException - Child context failed and the original exception could not be reconstructed | ||
| ├── ChildContextFailedException - Child context failed and the original exception could not be reconstructed | ||
| ├── MapIterationFailedException - Map iteration failed and the original exception could not be reconstructed | ||
| └── ParallelBranchFailedException - Parallel branch failed and the original exception could not be reconstructed |
Contributor
There was a problem hiding this comment.
Can we also mention SuspendExecutionException?
| var result = ctx.waitForCondition("poll", String.class, checkFunc); | ||
| } catch (WaitForConditionFailedException e) { | ||
| // Max attempts exceeded — condition was never met | ||
| } catch (IllegalStateException e) { |
Contributor
There was a problem hiding this comment.
When users should handle this IllegalStateException?
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
Issue Link, if available
#184
Description
Update all docs under docs/ except docs/spec, will update those in followup PR.
Demo/Screenshots
N/A
Checklist
Testing
Unit Tests
Have unit tests been written for these changes? N/A
Integration Tests
Have integration tests been written for these changes? N/A
Examples
Has a new example been added for the change? (if applicable) N/A