haskell-distributed / haskell-distributed/distributed-process

Deprecate withMonitor or fuse withMonitorRef

Open
#281 7 comments 1 reaction 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

I think it's confusing to have both withMonitor and withMonitorRef. The two functions are nearly identical. Could we either deprecate withMonitor, since withMonitorRef is all that's needed, or (at the cost of a breaking change) make the naming consistent with base: i.e.

withMonitor :: ProcessId -> (MonitorRef -> Process a) -> Process a
withMonitor_ :: ProcessId -> Process a -> Process a

(as in mask_ and bracket_ in Control.Exception and elsewhere)

If we deprecate withMonitor now, it leaves us free to recycle that name to make the naming consistent in a later release.

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 by locating the withMonitor and withMonitorRef definitions and their usages. The issue presents two alternatives rather than a decided change, so completion depends on choosing and applying one consistent API direction.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
distributed-systems
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.