Skip to content

Improve documentation of SetupHooks, unexposing some internal constructors#11771

Open
sheaf wants to merge 1 commit intomasterfrom
doc-hooks
Open

Improve documentation of SetupHooks, unexposing some internal constructors#11771
sheaf wants to merge 1 commit intomasterfrom
doc-hooks

Conversation

@sheaf
Copy link
Copy Markdown
Collaborator

@sheaf sheaf commented Apr 29, 2026 •
edited
Loading

Changes:

  • Add an usage overview that explains what the various hooks may be useful for.
  • Add a worked example for dynamicRule as it is the most complex aspect of the API.
  • Unexpose the gnarly RuleCommands constructors, advising usage of staticRule and dynamicRule instead.
  • Various small tweaks, including additional haddock comments for dynamicRule.

Template Α: This PR modifies behaviour or interface

@sheaf sheaf mentioned this pull request Apr 29, 2026
Open
@sheaf
Copy link
Copy Markdown
Collaborator Author

sheaf commented Apr 30, 2026

I've added a new "how to use SetupHooks" guide entry now.

@sheaf sheaf mentioned this pull request Apr 30, 2026
Open
6 tasks
Mikolaj
Mikolaj approved these changes Apr 30, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@Mikolaj Mikolaj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I totally approve!

ulysses4ever
ulysses4ever reviewed May 5, 2026
View reviewed changes
Comment thread changelog.d/UnexposeRuleCommands.md
ulysses4ever
ulysses4ever approved these changes May 5, 2026
View reviewed changes
Comment thread Cabal-hooks/src/Distribution/Simple/SetupHooks.hs Outdated
Comment thread Cabal-hooks/src/Distribution/Simple/SetupHooks.hs Outdated
@sheaf sheaf changed the title Improve documentation of SetupHooks Improve documentation of SetupHooks, unexposing some internal constructors May 6, 2026
@sheaf sheaf added merge me Tell Mergify Bot to merge and removed attention: needs-review labels May 6, 2026
@sheaf
Improve documentation of SetupHooks
90c3a52 
Adds a how-to guide in the Cabal's user guide.

Changes to the SetupHooks module and Haddocks:

  - Add an usage overview that explains what the various hooks may
    be useful for.
  - Add a worked example for 'dynamicRule' as it is the most complex
    aspect of the API.
  - Unexpose the gnarly 'RuleCommands' constructors, advising usage of
    'staticRule' and 'dynamicRule' instead.
  - Various small tweaks, including additional haddock comments for
    'dynamicRule'.

Fixes #11461
@mergify mergify Bot added ready and waiting Mergify is waiting out the cooldown period merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days queued labels May 6, 2026
@mergify
Copy link
Copy Markdown
Contributor

mergify Bot commented May 8, 2026 •
edited
Loading

Merge Queue Status

This pull request spent 1 hour 39 minutes 16 seconds in the queue, including 1 hour 28 minutes 46 seconds running CI.

Waiting for any of
  • check-neutral = Validate post job
  • check-skipped = Validate post job
  • check-success = Validate post job
All conditions
  • any of [🛡 GitHub branch protection]:
    • check-neutral = Validate post job
    • check-skipped = Validate post job
    • check-success = Validate post job
  • #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 = 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

Reason

The merge conditions cannot be satisfied due to failing checks

Failing checks:

Hint

You may have to fix your CI before adding the pull request to the queue again.
If you update this pull request, to fix the CI, it will automatically be requeued once the queue conditions match again.
If you think this was a flaky issue instead, you can requeue the pull request, without updating it, by posting a @mergifyio queue comment.

mergify Bot added a commit that referenced this pull request May 8, 2026
@mergify
Merge of #11771
eeb374f
@mergify mergify Bot mentioned this pull request May 8, 2026
Closed
86 tasks
@mergify mergify Bot added dequeued and removed queued labels May 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ulysses4ever ulysses4ever ulysses4ever approved these changes

@Mikolaj Mikolaj Mikolaj approved these changes

Assignees

No one assigned

Labels

dequeued 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

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@sheaf @Mikolaj @ulysses4ever