constrained-generators: Improve haddocks

[MaximilianAlgehed]

Description

This is an attempt to get more reasonable (not entirely reasonable yet!) haddocks in place for constrained-generators. There will be some silly stuff like:

-- | This function foobarifies its inputs
foobarify :: inputs -> output

But the goal is to get 100% coverage of docs on the main library with mostly reasonable haddocks that can be improved over time.

closes #5143

Checklist

• Commits in meaningful sequence and with useful messages.
• Tests added or updated when needed.
• CHANGELOG.md files updated for packages with externally visible changes.
  NOTE: New section is never added with the code changes. (See RELEASING.md).
• Versions updated in .cabal and CHANGELOG.md files when necessary, according to the
  versioning process.
• Version bounds in .cabal files updated when necessary.
  NOTE: If bounds change in a cabal file, that package itself must have a version increase. (See RELEASING.md).
• Code formatted (use scripts/fourmolize.sh).
• Cabal files formatted (use scripts/cabal-format.sh).
• CDDL files are up to date (use scripts/gen-cddl.sh)
• hie.yaml updated (use scripts/gen-hie.sh).
• Self-reviewed the diff.

[TimSheard]

This looks good, just a few small typo comments. When we make haddock files, where do they go? It would be nice to look at the haddock files to judge how they look and feel.

[MaximilianAlgehed]

@TimSheard on my machine I get this output as the final lines from cabal haddock:

Documentation created:
/home/max/IOHK/cardano-ledger/dist-newstyle/build/x86_64-linux/ghc-9.12.2/constrained-generators-0.2.0.0/doc/html/constrained-generators

[MaximilianAlgehed]

@TimSheard I'll take another pass over the documentation and fix all the warnings and improve it some more after we've merged this, but I'd like to get the new repo set up first so that we have that out of the way.