Skip to content

docs: map#121

Open
yaythomas wants to merge 1 commit intoparallelfrom
map
Open

docs: map#121
yaythomas wants to merge 1 commit intoparallelfrom
map

Conversation

@yaythomas
Copy link
Copy Markdown
Contributor

Description of changes:

  • Replace Python-centric page with language-neutral rewrite
  • Add TypeScript, Python, and Java examples for all sections
  • Add Map Function subsection under Method signature with per-language type signatures and parameter docs
  • Document MapResult (Java) vs BatchResult (TS/Python) difference
  • Document SKIPPED status in Java vs STARTED in TS/Python
  • Fix completion strategy tables in map.md and parallel.md (were collapsed by mdformat; fixed with mdformat-gfm tables extension)
  • Remove item_batcher from MapConfig docs (not implemented)
  • Remove ToC, Terminology, Key Features, Best Practices, Performance Tips, FAQ, Testing sections

Issue #, if available:
closes #19, closes #22, closes #74, closes #56, closes #93, closes #94, ref #96

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

- Replace Python-centric page with language-neutral rewrite
- Add TypeScript, Python, and Java examples for all sections
- Add Map Function subsection under Method signature with
  per-language type signatures and parameter docs
- Document MapResult (Java) vs BatchResult (TS/Python) difference
- Document SKIPPED status in Java vs STARTED in TS/Python
- Fix completion strategy tables in map.md and parallel.md
  (were collapsed by mdformat; fixed with mdformat-gfm tables extension)
- Remove item_batcher from MapConfig docs (not implemented)
- Remove ToC, Terminology, Key Features, Best Practices,
  Performance Tips, FAQ, Testing sections

closes #19, closes #22, closes #74, closes #56, closes #93, closes #94, ref #96
@yaythomas yaythomas moved this from Backlog to In review in aws-durable-execution Apr 9, 2026
concurrency, collects results as items complete, and checkpoints the outcome.

[← Back to main index](../index.md)
Each item runs in its own child context and checkpoints its result independently as it
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link to child context?

## Getting started

Here's a simple example of processing a collection:
Use map to apply the same operation to every item in a collection. Use
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the collection need to be ordered given the way checkpoint ids are incremented?

```

**Q: How do I access individual results?**
## Completion strategies
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is used in both parallel and map, right? Should it be moved to a dedicated section to be referenced by both?

Use `result.get_map()` to inspect the map operation:
Each item checkpoints its result on completion. Items that have not completed when the
map reaches its completion criteria remain with status `STARTED` (TypeScript and Python)
or `SKIPPED` (Java).
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In parallel I don't think we call out this distinction and only reference STARTED

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In review

Development

Successfully merging this pull request may close these issues.

2 participants