Improve documentation of SetupHooks, unexposing some internal constructors#11771
Merged
Conversation
Collaborator
Author
|
I've added a new "how to use SetupHooks" guide entry now. |
6 tasks
ulysses4ever
reviewed
May 5, 2026
ulysses4ever
approved these changes
May 5, 2026
sheaf
changed the title
sheaf
added
merge me
mergify
Bot
added
ready and waiting
Contributor
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
All conditions
ReasonThe merge conditions cannot be satisfied due to failing checks Failing checks: HintYou may have to fix your CI before adding the pull request to the queue again. |
86 tasks
mergify
Bot
added
dequeued
waiting too long
Member
|
@sheaf: sadly, it seems there are conflicts with master now. |
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
Collaborator
Author
That's strange, I rebased just now and there were no conflicts. |
sheaf
removed
ready and waiting
Collaborator
|
@sheaf This looks like an internet error due to GitHub instability. I think you should restart CI or rebase. |
Contributor
Merge Queue Status
This pull request spent 2 hours 32 minutes 40 seconds in the queue, including 1 hour 29 minutes 34 seconds running CI. Required conditions to merge
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes:
dynamicRuleas it is the most complex aspect of the API.RuleCommandsconstructors, advising usage ofstaticRuleanddynamicRuleinstead.dynamicRule.Template Α: This PR modifies behaviour or interface