Skip to content

Commit

Permalink
README of testsuite: fix formatting in doctest section
Browse files Browse the repository at this point in the history
  • Loading branch information
andreasabel authored and Mikolaj committed Oct 5, 2023
1 parent bf52f18 commit 1f4c716
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions cabal-testsuite/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,9 @@ There are a few useful flags:
the autodetection doesn't work correctly (which may be the
case for old versions of GHC.)

doctests
========
### How to run the doctests

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

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

How to write
------------
Expand Down

0 comments on commit 1f4c716

Please sign in to comment.