Skip to content

Improve documentation consistency#16

Merged
agustinmista merged 3 commits into
mainfrom
copilot/improve-documentation-consistency
Nov 25, 2025
Merged

Improve documentation consistency#16
agustinmista merged 3 commits into
mainfrom
copilot/improve-documentation-consistency

Conversation

Copilot AI commented Nov 25, 2025

Copy link
Copy Markdown

Standardize Haddock documentation across the codebase to consistently end with periods and fix various typos discovered during the review.

Documentation Consistency

  • Added trailing periods to all module-level, function-level, type-level, and field-level Haddock comments

Typo Fixes

  • possitionposition
  • mosltymostly
  • whithinwithin
  • determinsticallydeterministically
  • acceptecaccepted
  • prunningpruning
  • fullfillingfulfilling
  • constraningconstraining
  • AbtractAbstract
  • patterpattern
  • indefinetelyindefinitely

Example

Before:

-- | Configuration options for Mutagen
module Test.Mutagen.Config

-- | Breadcrumbs used to place mutations inside of values
type Pos = [Int]

After:

-- | Configuration options for Mutagen.
module Test.Mutagen.Config

-- | Breadcrumbs used to place mutations inside of values.
type Pos = [Int]
Original prompt

Improve the documentation of this package, paying special attention to consistency (e.g, periods)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits November 25, 2025 19:10
…mments

Co-authored-by: agustinmista <5265348+agustinmista@users.noreply.github.com>
Co-authored-by: agustinmista <5265348+agustinmista@users.noreply.github.com>
Copilot AI changed the title [WIP] Improve documentation for package consistency Improve documentation consistency: add periods to all Haddock comments and fix typos Nov 25, 2025
Copilot AI requested a review from agustinmista November 25, 2025 19:15
@agustinmista agustinmista changed the title Improve documentation consistency: add periods to all Haddock comments and fix typos Improve documentation consistency Nov 25, 2025
@agustinmista agustinmista marked this pull request as ready for review November 25, 2025 19:27
@agustinmista agustinmista merged commit a5ecffd into main Nov 25, 2025
12 checks passed
@agustinmista agustinmista deleted the copilot/improve-documentation-consistency branch November 25, 2025 19:27
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