Skip to content

Fix haddock formatting

Konstantin Ivanov requested to merge martoon/fix-docs into master

Description

Problem: documentation for Scope module does not render correctly, lists are displayed at the same line.

Solution: I wrote so because I thought that for proper haddock I have to put empty line before/after each list entry, and that would make haddock comment itself look not very neat.

But today I was said that empty lines are necessary only before/after the entire list, and I can live with that.

Related issue(s)

Checklist for your Merge Request

Related changes (conditional)

  • Tests (see short guidelines)

    • If I added new functionality, I added tests covering it.
    • If I fixed a bug, I added a regression test to prevent the bug from silently reappearing again.
  • Documentation

    • I checked whether I should update the docs and did so if necessary:
    • I updated changelog files of all affected packages released to Hackage if my changes are externally visible.

Stylistic guide (mandatory)

Edited by Konstantin Ivanov

Merge request reports