Skip to content

Haddocks for GenericPlanPackage#11856

Merged
mergify[bot] merged 1 commit into
haskell:masterfrom
cabalism:doc/GenericPlanPackage-haddocks
May 23, 2026
Merged

Haddocks for GenericPlanPackage#11856
mergify[bot] merged 1 commit into
haskell:masterfrom
cabalism:doc/GenericPlanPackage-haddocks

Conversation

@philderbeast
Copy link
Copy Markdown
Collaborator

@philderbeast philderbeast commented May 20, 2026

Fixes #11855. Moves the PackageInstalled instance note to the module, explains the ipkg and srcpkg type parameters and adds haddocks for PreExisting, Configured and Installed, GenericPlanPackage constructors. As rendered:

image image

There's a longer note above GenericPlanPackage with more detail that I've left as-is and not exposed in haddocks.


  • Patches conform to the coding conventions.
  • Is this a PR that fixes CI? If so, it will need to be backported to older cabal release branches (ask maintainers for directions).

Comment thread cabal-install/src/Distribution/Client/InstallPlan.hs Outdated
@philderbeast philderbeast added merge me Tell Mergify Bot to merge and removed attention: needs-review labels May 21, 2026
@mergify mergify Bot added the ready and waiting Mergify is waiting out the cooldown period label May 21, 2026
- Fake admonition with @@
- Try to explain the type arguments
- Fix a grammar typo "package that aren't"
- Replace @...@ with heading
- Use monotype in warning
- Move 'PackageInstalled' note
@philderbeast philderbeast force-pushed the doc/GenericPlanPackage-haddocks branch from 5847756 to cb814ed Compare May 21, 2026 19:29
@mergify mergify Bot added merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days queued labels May 23, 2026
@mergify
Copy link
Copy Markdown
Contributor

mergify Bot commented May 23, 2026

Merge Queue Status

This pull request spent 2 hours 28 minutes 38 seconds in the queue, including 1 hour 42 minutes 12 seconds running CI.

Required conditions to merge

mergify Bot added a commit that referenced this pull request May 23, 2026
@mergify mergify Bot merged commit 6d67235 into haskell:master May 23, 2026
165 of 170 checks passed
@mergify mergify Bot removed the queued label May 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days merge me Tell Mergify Bot to merge ready and waiting Mergify is waiting out the cooldown period

Projects

None yet

Development

Successfully merging this pull request may close these issues.

GenericPlanPackage haddocks

3 participants