From 69396b1f0a094214f095b71ac9d1ce56f8458491 Mon Sep 17 00:00:00 2001 From: Chris Martin Date: Mon, 25 Nov 2024 11:41:51 -0700 Subject: [PATCH] add package description to satisfy cabal (#212) --- persistent-sql-lifted/package.yaml | 10 +++++++++- persistent-sql-lifted/persistent-sql-lifted.cabal | 9 ++++++++- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/persistent-sql-lifted/package.yaml b/persistent-sql-lifted/package.yaml index 3bbca7d..e9682a1 100644 --- a/persistent-sql-lifted/package.yaml +++ b/persistent-sql-lifted/package.yaml @@ -5,7 +5,15 @@ maintainer: Freckle Education category: Database github: freckle/freckle-app synopsis: Monad classes for running queries with Persistent and Esqueleto -description: Please see README.md +description: | + This package introduces two classes: MonadSqlBackend for monadic contexts in + which a SqlBackend is available, and MonadSqlBackend for contexts in which we + can execute a SQL transaction. + + Additionally, this package provides variants of query-running utilities from + Persistent and Esqueleto which are concretized to use SqlBackend, generalized + to a MonadSqlBackend m constraint rather than "ReaderT backend", and wrapped in + checkpointCallStack so that exceptions will include call stacks. extra-doc-files: - README.md diff --git a/persistent-sql-lifted/persistent-sql-lifted.cabal b/persistent-sql-lifted/persistent-sql-lifted.cabal index 5193013..53f3e8a 100644 --- a/persistent-sql-lifted/persistent-sql-lifted.cabal +++ b/persistent-sql-lifted/persistent-sql-lifted.cabal @@ -7,7 +7,14 @@ cabal-version: 1.18 name: persistent-sql-lifted version: 0.1.0.0 synopsis: Monad classes for running queries with Persistent and Esqueleto -description: Please see README.md +description: This package introduces two classes: MonadSqlBackend for monadic contexts in + which a SqlBackend is available, and MonadSqlBackend for contexts in which we + can execute a SQL transaction. + . + Additionally, this package provides variants of query-running utilities from + Persistent and Esqueleto which are concretized to use SqlBackend, generalized + to a MonadSqlBackend m constraint rather than "ReaderT backend", and wrapped in + checkpointCallStack so that exceptions will include call stacks. category: Database homepage: https://github.com/freckle/freckle-app#readme bug-reports: https://github.com/freckle/freckle-app/issues