haskell-distributed / haskell-distributed/distributed-process

Document the semantics of receiveWait and similar

Open
#261 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Haskell
Stars
751
Forks
99
Avg merge
45m
Merged PRs (30d)
2

Description

Currently the documentation reads:

-- | Test the matches in order against each message in the queue
receiveWait :: [Match b] -> Process b Source

This is not sufficient, I think, to understand how receiveWait works in the presence of multiple messages in the mailbox and multiple match clauses. The order in which matches are done should be stated less succinctly.

I suppose we should also say that this function:

  • blocks when no message matches
  • it is interruptible when no message matches (can it be interrupted even if some message matches?).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the receiveWait API documentation and inspect the surrounding documentation for similar receive functions. Confirm the mailbox and match-clause ordering, blocking when no message matches, and interruptibility, including the case where some messages match. Done means these semantics are stated clearly in the documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
distributed-systems, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.