Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 22, 2026

Documentation was scattered and inconsistent across .cabal, README.md, and the PostgresqlTypes module. 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 inputs
  • refineFrom* - Constructors returning Maybe, failing on invalid input
  • to* - Accessors extracting values to common Haskell types (always safe/total)

All three documentation sources now maintain consistent terminology and organization.

Original prompt

Restructure the docs. Move the listing to the cabal file and in the PostgresqlTypes module organize the exports by the categories mentioned in the original listing. Add notes on the function naming conventions. Make the documentation consistent across .cabal, README and the PostgresqlTypes module.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI changed the title [WIP] Restructure documentation and organize PostgresqlTypes module Restructure documentation: organize type listings by category and document function naming conventions Jan 22, 2026
Copilot AI requested a review from nikita-volkov January 22, 2026 13:49
@nikita-volkov nikita-volkov force-pushed the copilot/restructure-docs-and-export-categories branch from d34ed45 to 214bbb4 Compare January 22, 2026 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants