docs: explain operation nesting trade-offs - #246
Open
yaythomas wants to merge 2 commits into
Open
Conversation
Document nested and flat behavior for map and parallel operations across TypeScript, Python, Java, and C#. Update configuration examples and reconcile checkpointing guidance. Document TypeScript summary generators and Python and Java item naming. Closes #188 Closes #244 Closes #245 Builds on the initial documentation and discussion by @lyushher in #194.
yaythomas
had a problem deploying
to
ai-pr-review-runtime
August 11, 2026 20:25 — with 
GitHub Actions
Failure
GitHub Actions
Failure
yaythomas
had a problem deploying
to
ai-pr-review-runtime
August 11, 2026 20:25 — with
GitHub Actions
Failure
GitHub Actions
Failure
This was referenced Aug 11, 2026
- Use the released generic MapConfig<TItem> in the C# examples and the map.md C# API block, and correct the C# map completion default to AllSuccessful() in the API block, factory list, and strategy table. - Fix the Java map example, which failed to compile because HttpClient.send throws checked IOException and InterruptedException. - Return get_results() from the Python map examples so they match their list[str] annotations and the other three languages. - Add Python and Java item-namer examples and document the typed Java itemNamer overload, completing four-language naming coverage. - Clarify both checkpointing preambles, which claimed the language-specific details describe nested mode while the C# tabs describe nested and flat.
yaythomas
had a problem deploying
to
ai-pr-review-runtime
August 13, 2026 21:12 — with
GitHub Actions
Failure
GitHub Actions
Failure
yaythomas
had a problem deploying
to
ai-pr-review-runtime
August 13, 2026 21:12 — with
GitHub Actions
Failure
GitHub Actions
Failure
| Each item runs in its own [child context](child-context.md) and checkpoints its result | ||
| independently as it completes. | ||
| Each item runs in its own [child context](child-context.md). The default nested mode | ||
| checkpoints that context and its result. Flat mode omits the per-item context checkpoint to |
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
2 participants
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.
Summary
Python, Java, and C#.
summaryGeneratorconfiguration for map and parallel.nesting restriction.
Closes #188.
Closes #244.
Closes #245.
Supersedes #194. Thanks @lyushher for the initial documentation and
discussion that shaped this update.
Validation
mdformat --check docs/codespell docs/python3 scripts/vendor_mermaid.py --checkpython3 scripts/vendor_glightbox.py --checkpython3 scripts/check_example_refs.pyzensical build --cleangit diff --checkAn independent review completed with no actionable findings.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.