Skip to content

Haddocks for GenericPlanPackage#11856

Open
philderbeast wants to merge 1 commit into
haskell:masterfrom
cabalism:doc/GenericPlanPackage-haddocks
Open

Haddocks for GenericPlanPackage#11856
philderbeast wants to merge 1 commit into
haskell:masterfrom
cabalism:doc/GenericPlanPackage-haddocks

Conversation

@philderbeast
Copy link
Copy Markdown
Collaborator

@philderbeast philderbeast commented May 20, 2026 •
edited
Loading

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).

ffaf1
ffaf1 reviewed May 20, 2026
View reviewed changes
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
@philderbeast
PreExisting, Configured, Installed haddocks
cb814ed 
- 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 •
edited
Loading

Merge Queue Status

Waiting for any of
  • check-neutral = Validate post job
  • check-skipped = Validate post job
  • check-success = Validate post job
All merge conditions
Required conditions to stay in the queue
  • -closed [📌 queue requirement]
  • -conflict [📌 queue requirement]
  • -draft [📌 queue requirement]
  • any of [📌 queue -> configuration change requirements]:
    • -mergify-configuration-changed
    • check-success = Configuration changed
  • any of [🔀 queue conditions]:
    • all of [📌 queue conditions of queue rule default]:
      • #approved-reviews-by >= 2 [🛡 GitHub branch protection]
      • #changes-requested-reviews-by = 0 [🛡 GitHub branch protection]
      • #review-threads-unresolved = 0 [🛡 GitHub branch protection]
      • any of [🛡 GitHub branch protection]:
        • check-success = Doctest Cabal
        • check-neutral = Doctest Cabal
        • check-skipped = Doctest Cabal
      • any of [🛡 GitHub branch protection]:
        • check-success = Meta checks
        • check-neutral = Meta checks
        • check-skipped = Meta checks
      • any of [🛡 GitHub branch protection]:
        • check-success = docs/readthedocs.org:cabal
        • check-neutral = docs/readthedocs.org:cabal
        • check-skipped = docs/readthedocs.org:cabal
      • any of [🛡 GitHub branch protection]:
        • check-success = Validate post job
        • check-neutral = Validate post job
        • check-skipped = Validate post job
      • any of [🛡 GitHub branch protection]:
        • check-success = fourmolu
        • check-neutral = fourmolu
        • check-skipped = fourmolu
      • any of [🛡 GitHub branch protection]:
        • check-success = hlint
        • check-neutral = hlint
        • check-skipped = hlint
      • any of [🛡 GitHub branch protection]:
        • check-success = Bootstrap post job
        • check-neutral = Bootstrap post job
        • check-skipped = Bootstrap post job
      • any of [🛡 GitHub branch protection]:
        • check-success = whitespace
        • check-neutral = whitespace
        • check-skipped = whitespace
      • any of [🛡 GitHub branch protection]:
        • check-success = Check sdist post job
        • check-neutral = Check sdist post job
        • check-skipped = Check sdist post job
      • any of [🛡 GitHub branch protection]:
        • check-success = Changelogs
        • check-neutral = Changelogs
        • check-skipped = Changelogs
    • all of [📌 queue conditions of queue rule squash-merge]:
      • #approved-reviews-by >= 2 [🛡 GitHub branch protection]
      • #changes-requested-reviews-by = 0 [🛡 GitHub branch protection]
      • #review-threads-unresolved = 0 [🛡 GitHub branch protection]
      • any of [🛡 GitHub branch protection]:
        • check-success = Doctest Cabal
        • check-neutral = Doctest Cabal
        • check-skipped = Doctest Cabal
      • any of [🛡 GitHub branch protection]:
        • check-success = Meta checks
        • check-neutral = Meta checks
        • check-skipped = Meta checks
      • any of [🛡 GitHub branch protection]:
        • check-success = docs/readthedocs.org:cabal
        • check-neutral = docs/readthedocs.org:cabal
        • check-skipped = docs/readthedocs.org:cabal
      • any of [🛡 GitHub branch protection]:
        • check-success = Validate post job
        • check-neutral = Validate post job
        • check-skipped = Validate post job
      • any of [🛡 GitHub branch protection]:
        • check-success = fourmolu
        • check-neutral = fourmolu
        • check-skipped = fourmolu
      • any of [🛡 GitHub branch protection]:
        • check-success = hlint
        • check-neutral = hlint
        • check-skipped = hlint
      • any of [🛡 GitHub branch protection]:
        • check-success = Bootstrap post job
        • check-neutral = Bootstrap post job
        • check-skipped = Bootstrap post job
      • any of [🛡 GitHub branch protection]:
        • check-success = whitespace
        • check-neutral = whitespace
        • check-skipped = whitespace
      • any of [🛡 GitHub branch protection]:
        • check-success = Check sdist post job
        • check-neutral = Check sdist post job
        • check-skipped = Check sdist post job
      • any of [🛡 GitHub branch protection]:
        • check-success = Changelogs
        • check-neutral = Changelogs
        • check-skipped = Changelogs

mergify Bot added a commit that referenced this pull request May 23, 2026
@mergify
Merge of #11856
a8695a7
This was referenced May 23, 2026
Open
Open
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ffaf1 ffaf1 ffaf1 approved these changes

@Mikolaj Mikolaj Mikolaj approved these changes

Assignees

No one assigned

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 queued ready and waiting Mergify is waiting out the cooldown period

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

GenericPlanPackage haddocks

3 participants

@philderbeast @Mikolaj @ffaf1