Haddock: Fix very confusing formatting errors (copy #2622)

[mergify]

This is an automatic copy of pull request #2622 done by Mergify.
Cherry-pick of cb401b8 has failed:

On branch mergify/copy/1.6/pr-2622
Your branch is up to date with 'origin/1.6'.

You are currently cherry-picking commit cb401b8c5.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   clash-cosim/src/Clash/CoSim/DSLParser.hs
	modified:   clash-lib/src/Clash/Normalize/Transformations/Case.hs
	modified:   clash-lib/src/Clash/Normalize/Transformations/Cast.hs
	modified:   clash-lib/src/Clash/Normalize/Transformations/MultiPrim.hs
	modified:   clash-lib/src/Clash/Normalize/Transformations/Specialize.hs
	modified:   clash-prelude/src/Clash/Annotations/Primitive.hs
	modified:   clash-prelude/src/Clash/Annotations/SynthesisAttributes.hs
	modified:   clash-prelude/src/Clash/Examples.hs
	modified:   clash-prelude/src/Clash/Explicit/BlockRam/File.hs
	modified:   clash-prelude/src/Clash/Explicit/ROM/File.hs
	modified:   clash-prelude/src/Clash/Explicit/Reset.hs
	modified:   clash-prelude/src/Clash/Explicit/Signal.hs
	modified:   clash-prelude/src/Clash/Explicit/Verification.hs
	modified:   clash-prelude/src/Clash/Prelude/BlockRam/File.hs
	modified:   clash-prelude/src/Clash/Prelude/DataFlow.hs
	modified:   clash-prelude/src/Clash/Prelude/ROM/File.hs
	modified:   clash-prelude/src/Clash/Promoted/Nat.hs
	modified:   clash-prelude/src/Clash/Signal.hs
	modified:   clash-prelude/src/Clash/Signal/BiSignal.hs
	modified:   clash-prelude/src/Clash/Signal/Bundle.hs
	modified:   clash-prelude/src/Clash/Sized/Fixed.hs
	modified:   clash-prelude/src/Clash/Sized/RTree.hs
	modified:   clash-prelude/src/Clash/Sized/Vector.hs
	modified:   tests/src/Test/Tasty/Ghdl.hs
	modified:   tests/src/Test/Tasty/Iverilog.hs

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	deleted by us:   clash-ffi/src/Clash/FFI/VPI/Object/Value/Parse.hs
	both modified:   clash-lib/src/Clash/Netlist/Util.hs
	both modified:   clash-lib/src/Clash/Primitives/DSL.hs
	both modified:   clash-prelude/src/Clash/Annotations/TopEntity.hs
	both modified:   clash-prelude/src/Clash/Explicit/Testbench.hs
	both modified:   clash-prelude/src/Clash/Intel/ClockGen.hs
	both modified:   clash-prelude/src/Clash/Tutorial.hs
	both modified:   clash-prelude/src/Clash/Xilinx/ClockGen.hs

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

---

Mergify commands and options

More conditions and actions can be found in the documentation.

You can also trigger Mergify actions by commenting on this pull request:

• @Mergifyio refresh will re-evaluate the rules
• @Mergifyio rebase will rebase this PR on its base branch
• @Mergifyio update will merge the base branch into this PR
• @Mergifyio backport <destination> will backport this PR on <destination> branch

Additionally, on Mergify dashboard you can:

• look at your merge queues
• generate the Mergify configuration with the config editor.

Finally, you can contact us on https://mergify.com

[martijnbastiaan]

Given the number of merge conflicts I'm inclined to say.. 1.6 is dead to us? @DigitalBrains1

[DigitalBrains1]

That kinda depends on whether we do another point release. #2588 is good to have in a point release; but I don't think it directly caused any issues with HDL generation.

If we do another point release, I want this in, so I'll do the work :-S. Including hand-checking the resulting Haddock, probably, because it is so finicky. I was just really very much done with this work after this PR on master and 1.8, and postponed dealing with this one for a time when it would cause less aversion.

[edit]
I never doubted this would be a backport which would need a lot of conflict resolution :-)
[/edit]

[martijnbastiaan]

We've historically only supported 1 major version due to capacity constraints..