From fb0e8e39f13000c5eef9611ce5313cdbb6f7fbfe Mon Sep 17 00:00:00 2001 From: Harry Garrood Date: Fri, 11 Oct 2019 00:08:07 +0100 Subject: [PATCH 1/2] Update module comment in Database.Persist.TH Fixes #967 --- persistent-template/Database/Persist/TH.hs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/persistent-template/Database/Persist/TH.hs b/persistent-template/Database/Persist/TH.hs index b7b41c969..9382a93fb 100644 --- a/persistent-template/Database/Persist/TH.hs +++ b/persistent-template/Database/Persist/TH.hs @@ -9,8 +9,8 @@ {-# LANGUAGE UndecidableInstances #-} {-# OPTIONS_GHC -fno-warn-orphans -fno-warn-missing-fields #-} --- | This module provides utilities for creating backends. Regular users do not --- need to use this module. +-- | This module provides the tools for defining your database schema and using +-- it to generate Haskell data types and migrations. module Database.Persist.TH ( -- * Parse entity defs persistWith From 132e70b90765d3c5c4a4969cafada8c3b2d5aa07 Mon Sep 17 00:00:00 2001 From: Harry Garrood Date: Fri, 11 Oct 2019 00:13:37 +0100 Subject: [PATCH 2/2] Update changelog for #967 --- persistent-template/ChangeLog.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/persistent-template/ChangeLog.md b/persistent-template/ChangeLog.md index c07633766..8ec78ab69 100644 --- a/persistent-template/ChangeLog.md +++ b/persistent-template/ChangeLog.md @@ -1,3 +1,7 @@ +## Unreleased changes + +* Update module documentation for `Database.Persist.TH` to better describe the purpose of the module [#968](https://github.com/yesodweb/persistent/pull/968) + ## 2.7.2 * Expose the knot tying logic of `parseReferences` so that users can build