SimEvent redesign

Open
  • Is something wrong?
#244 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Refactor
Clarity
Needs clarification
Activity status
Quiet
Tech stack
haskell
Domain
testing-qa

Research direction

Start by locating the definitions and usages of SimEvent, SimPOREvent, and SimRacesFound in the repository. Read how callers pattern-match on these constructors and determine the public shape that removes the need to handle the internal constructor. Done means the redesign is implemented without exposing SimRacesFound as a required caller case and existing behavior remains covered by the relevant tests.

Written by the indexing model from the issue text.

Description

SimEvent type has three constructors, SimEvent, SimPOREvent and SimRacesFound. SimRacesFound is only internal, and one shouldn't need to pattern-match on it when using io-sim. SimEvent should be redesigned so the compiler does not require pattern matching on SimRacesFound.

Dominant language
Haskell
Stars
57
Forks
25
No merged PRs in 30d

Getting set up

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.

More from IntersectMBO/io-sim

All issues in IntersectMBO/io-sim

Similar issues

More Haskell issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.