Skip to content

Commit 2870f4b

Browse files
authored
Merge pull request #9287 from haskell/README-testsuite
README of testsuite: fix formatting in `doctest` section
2 parents bf52f18 + 1f4c716 commit 2870f4b

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

cabal-testsuite/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,9 @@ There are a few useful flags:
2525
the autodetection doesn't work correctly (which may be the
2626
case for old versions of GHC.)
2727

28-
doctests
29-
========
28+
### How to run the doctests
3029

31-
You need to install the doctest tool. Make sure it's compiled with your current
30+
You need to install the `doctest` tool. Make sure it's compiled with your current
3231
GHC, and don't forget to reinstall it every time you switch GHC version:
3332

3433
``` shellsession
@@ -45,7 +44,7 @@ In this example we have run doctests in `Cabal-syntax`. Notice, that some
4544
components have broken doctests
4645
([#8734](https://github.com/haskell/cabal/issues/8734));
4746
our CI currently checks that `Cabal-syntax` and `Cabal` doctests pass via
48-
`make doctest-install && make doctest` (you can use this make-based workflow too).
47+
`make doctest-install && make doctest` (you can use this `make`-based workflow too).
4948

5049
How to write
5150
------------

0 commit comments

Comments
 (0)