alibaba / alibaba/async_simple
[docs] Update behavior for user-defined awaiter
- Dominant language
- C++
- Stars
- 2.2k
- Forks
- 316
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
### Search before asking
- [x] I searched the [issues](https://github.com/alibaba/async_simple/issues) and found no similar issues.
### What happened + What you expected to happen
When user defines an awaiter, if the `awaiter` didn't implement `coAwait` method, the `ViaCoroutine` helper will be invoked to switch the context. However, the behavior is not documented. So here is the confusion: https://github.com/alibaba/async_simple/discussions/162
- [x] Yes I am willing to submit a PR!
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the user-defined awaiter behavior described in the issue and discussion #162, then locate the existing documentation for awaiters and the ViaCoroutine helper. Done when the documentation explains what happens when an awaiter lacks a coAwait method and how context switching behaves.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100