Document send/recv tally
Open
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 1.5k
- Forks
- 368
- Avg merge
- 19h 32m
- Merged PRs (30d)
- 3
Description
The notify_send_ready and notify_recv_ready messages used in the tcp backend (and future uv backend, see #195) need better documentation. The protocol how these are sequenced as well.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the tcp backend uses of notify_send_ready and notify_recv_ready, then trace how those messages are sequenced. Document their meanings and ordering, including the future uv backend context from #195. Done means the message roles and protocol sequence are clear to readers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- distributed-systems, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100