Skip to content

docs: Add error handling to "Processing helpers" section (#2263) - #2325

Open
rchiang wants to merge 2 commits into
cocoindex-io:mainfrom
rchiang:rc-docs-map1
Open

docs: Add error handling to "Processing helpers" section (#2263)#2325
rchiang wants to merge 2 commits into
cocoindex-io:mainfrom
rchiang:rc-docs-map1

Conversation

@rchiang

@rchiang rchiang commented Jul 27, 2026

Copy link
Copy Markdown

Added section on error handling. Also adjusted the header and some of the text in the map() section to improve searchability.

@badmonster0

Copy link
Copy Markdown
Member

@georgeh0 can help take a look!

@badmonster0
badmonster0 requested a review from georgeh0 July 30, 2026 05:17
@rchiang

rchiang commented Jul 31, 2026

Copy link
Copy Markdown
Author

@georgeh0 can help take a look!

Weird. This was supposed to be tied to #2263 (which has some additional suggestions), so I'm not sure how it ended up as a separate pull request.

Comment thread docs/src/content/docs/programming_guide/processing_component.mdx Outdated
Comment thread docs/src/content/docs/programming_guide/processing_component.mdx Outdated

### `map()`
`map()` applies an async function to each item in a collection, running all calls concurrently within the current processing component. Unlike [`mount()`](#mount) and [`mount_each()`](#mount_each), it does **not** create child processing components — it's purely concurrent execution (similar to `asyncio.gather()`).
### Using CocoIndex `map()` to apply transformations

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Everything in the doc is about CocoIndex, so we don't need to repeat "CocoIndex" here.

IMO something like this is sufficient:

`map()`: transform items concurrently

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

The two main reasons I went with a more "full English phrasing" in the header.

  1. Using a full phrase is a bit more common in the "user's guide" documentation style. The shortened version you are suggesting is more common in "reference" documentation style.
  2. I'm not sure if it will get fixed with search index configuration, but I think having too short phrasing in the headers is part of what makes the search bar matching a bit confusing in the search previews, especially combined with "Header 3" or "Header 4" style.

Comment thread docs/src/content/docs/programming_guide/processing_component.mdx Outdated
Comment thread docs/src/content/docs/programming_guide/processing_component.mdx Outdated
…o#2263)

Added section on error handling. Also adjusted the header and some of the
text in the map() section to improve searchability.
- Remove error handling section
- Fix some text to avoid confusion
- The doc changes are now just the title changes and the additional references
  to `coco.map()` to improve section ranking for search.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants