haskell-distributed / haskell-distributed/distributed-process
please improve API doc for send/receiveChan (capacity? order?)
Nobody has claimed this yet.
- Dominant language
- Haskell
- Stars
- 751
- Forks
- 99
- Avg merge
- 45m
- Merged PRs (30d)
- 2
Description
A "channel" can be one of many things, and the API docs don't say what's happening:
- does it have a capacity? (can it store messages?)
- if yes, what guarantees are there for message ordering? (is it FIFO in some concurrent sense, that is FIFO between a fixed pair of sender and receiver process?)
and the same for send/expect - with the extra difficulty that the underlying channel is untyped? What does this imply for message ordering (e.g., FIFO-by-type)?
You have some "INTERNAL NOTES" in C.D.Process - please make them visible in the Haddocks.
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 reading the C.D.Process internal notes and the Haddocks for send, receiveChan, and expect. Compare the documented behavior of typed and untyped channels, including capacity and ordering guarantees, then make the relevant notes visible in the API documentation. Done means the Haddocks answer the questions raised for send/receiveChan and send/expect.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- 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