Skip to content

Fix haddock inline code needing escaping#11521

Merged
mergify[bot] merged 1 commit intohaskell:masterfrom
cabalism:docs/escape-code-less-than
Feb 27, 2026
Merged

Fix haddock inline code needing escaping#11521
mergify[bot] merged 1 commit intohaskell:masterfrom
cabalism:docs/escape-code-less-than

Conversation

@philderbeast
Copy link
Collaborator

@philderbeast philderbeast commented Feb 24, 2026 •
edited
Loading

Minor rendering fix in haddock markup. Escaping is sometimes needed for special characters within inline code blocks, within @...@. The problem haddocks are for functions removeLowerBound, removeUpperBound and asVersionIntervals.

  • Before the fix:
image
  • After the fix:
image
  • 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 approved these changes Feb 25, 2026
View reviewed changes
Copy link
Collaborator

@ffaf1 ffaf1 left a comment

Choose a reason for hiding this comment

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

Thanks.

@philderbeast philderbeast added merge me Tell Mergify Bot to merge and removed attention: needs-review labels Feb 25, 2026
@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 Feb 25, 2026
@mergify
Copy link
Contributor

mergify bot commented Feb 27, 2026 •
edited
Loading

Merge Queue Status

Rule: default

This pull request spent 13 minutes 31 seconds in the queue, including 3 minutes 6 seconds running CI.

Required conditions to merge
  • any of [🛡 GitHub branch protection]:
    • check-neutral = Doctest Cabal
    • check-skipped = Doctest Cabal
    • check-success = Doctest Cabal
  • any of [🛡 GitHub branch protection]:
    • check-neutral = Meta checks
    • check-skipped = Meta checks
    • check-success = Meta checks
  • any of [🛡 GitHub branch protection]:
    • check-neutral = Validate post job
    • check-skipped = Validate post job
    • check-success = Validate post job
  • any of [🛡 GitHub branch protection]:
    • check-neutral = Bootstrap post job
    • check-skipped = Bootstrap post job
    • check-success = Bootstrap 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 = 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 = 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 Feb 27, 2026
@mergify
Merge of #11521
5ab590e
@mergify mergify bot mentioned this pull request Feb 27, 2026
Closed
86 tasks
@mergify mergify bot added dequeued and removed queued labels Feb 27, 2026
@geekosaur
Copy link
Collaborator

geekosaur commented Feb 27, 2026

@Mergifyio queue

@mergify
Copy link
Contributor

mergify bot commented Feb 27, 2026 •
edited
Loading

Merge Queue Status

Rule: default

This pull request spent 1 hour 54 minutes 23 seconds in the queue, including 1 hour 44 minutes 5 seconds running CI.

Required conditions to 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 mergify bot added queued and removed dequeued labels Feb 27, 2026
mergify bot added a commit that referenced this pull request Feb 27, 2026
@mergify
Merge of #11521
67ed21a
@mergify mergify bot mentioned this pull request Feb 27, 2026
Closed
86 tasks
@mergify mergify bot merged commit 80c9fb8 into haskell:master Feb 27, 2026
327 checks passed
@mergify mergify bot removed the queued label Feb 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@geekosaur geekosaur geekosaur approved these changes

@ffaf1 ffaf1 ffaf1 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 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

@philderbeast @geekosaur @ffaf1