yesodweb / yesodweb/persistent

newtype SqlPersistT

Open
#1,038 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Haskell
Stars
486
Forks
306
PR merge metrics
No merged PRs in 30d

Description

SqlPersistT is currently:

type SqlPersistT = ReaderT SqlBackend

It will become:

newtype SqlPersistT m a = SqlPersistT
  { unsafeRunSqlPersistT :: ReaderT SqlBackend m a
  }

This gives us the opportunity to provide better documentation and error messages for the type, along with better instances.

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 SqlPersistT definition and tracing its usages and existing instances. Check how the proposed newtype affects those call sites, then verify that documentation, error messages, and instances are improved without breaking the existing SQL persistence interface.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
databases
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.