persistent-documentation

Documentation DSL for persistent entities

LTS Haskell 23.24:	0.1.0.5
Stackage Nightly 2025-06-12:	0.1.0.6
Latest on Hackage:	0.1.0.6

See all snapshots persistent-documentation appears in

Apache-2.0 licensed by parsonsmatt

Maintained by [email protected]

This version can be pinned in stack with:persistent-documentation-0.1.0.6@sha256:f6216de2879e6b5a374a48ac15e08a9016527957988bedd3f153a9b8dd15ab3e,1498

Module documentation for 0.1.0.6

Data
- Data.SemiMap
- Data.StrMap
Database
- Database.Persist
  - Database.Persist.Documentation
    - Database.Persist.Documentation.Internal

Depends on 6 packages(full list with versions):

base, containers, mtl, persistent, template-haskell, text

persistent-documentation

Hackage-Deps

This library provides a DSL for attaching documentation to persistent entities as well as rendering documentation.

For an example, check out the test suite, and the rendered example.

Changes

Revision history for persistent-documentation

0.1.0.6

#16
- Render MigrationOnly fields for persistent >= 2.15.1.0

0.1.0.5

#12
- Make it build with GHC 9.6
#10
- Fix build with mtl-2.3

0.1.0.4

Replace newlines with line breaks in field comments as rendered by markdownTableRenderer #9

0.1.0.3

Support persistent-2.12 and persistent-2.13. #4

0.1.0.2

Support persistent-2.11.0.0 #3

0.1.0.1

Document use of the mkEntityDefList to expose the [EntityDef] generated by the Persistent QuasiQuoter instead of using the QQ value directly.

0.1.0.0 – YYYY-mm-dd

First version. Released on an unsuspecting world.