Restructure documentation: organize type listings by category and document function naming conventions #59
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation was scattered and inconsistent across
.cabal,README.md, and thePostgresqlTypesmodule. Type listings lacked organization, and function naming conventions were not formally documented.Changes
Cabal file: Added comprehensive type listings organized by category (Numeric, Character, Boolean, Binary Data, Date/Time, Network Address, Geometric, Bit String, UUID, JSON, Key-Value, Range) with descriptions. Added "Function Naming Conventions" section documenting the three function patterns.
PostgresqlTypes module: Reorganized exports and imports with Haddock section headers matching cabal categories. Added detailed documentation on function naming patterns with usage guidance.
README: Streamlined to reference cabal/Haddock docs as primary sources. Added "Documentation" section with links to Hackage and module documentation.
Function Naming Conventions Documented
normalizeFrom*- Constructors that always succeed by clamping/canonicalizing invalid inputsrefineFrom*- Constructors returningMaybe, failing on invalid inputto*- Accessors extracting values to common Haskell types (always safe/total)All three documentation sources now maintain consistent terminology and organization.
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.