Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sol committed Nov 3, 2023
1 parent 6bb14c4 commit a88ff8a
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,9 @@ Notes:
- If you use properties you need to pass `--build-depends=QuickCheck` and
`--build-depends=template-haskell` to `cabal repl`.

- You likely want to reset the warning strategy for `cabal repl` with
`--repl-options='-w -Wdefault'`.

- `doctest` always uses the version of GHC it was compiled with. Reinstalling
`doctest` with `cabal install doctest --overwrite-policy=always` before each
invocation ensures that it uses the same version of GHC as is on the `PATH`.
Expand All @@ -144,7 +147,7 @@ Notes:
So a more robust way to call `doctest` is as follows:

```
cabal install doctest --overwrite-policy=always && cabal build && cabal repl --build-depends=QuickCheck --build-depends=template-haskell --with-ghc=doctest
cabal install doctest --overwrite-policy=always && cabal build && cabal repl --build-depends=QuickCheck --build-depends=template-haskell --with-ghc=doctest --repl-options='-w -Wdefault'
```

(This is what you want to use on CI.)
Expand Down
5 changes: 4 additions & 1 deletion doc/README.template.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,9 @@ Notes:
- If you use properties you need to pass `--build-depends=QuickCheck` and
`--build-depends=template-haskell` to `cabal repl`.

- You likely want to reset the warning strategy for `cabal repl` with
`--repl-options='-w -Wdefault'`.

- `doctest` always uses the version of GHC it was compiled with. Reinstalling
`doctest` with `cabal install doctest --overwrite-policy=always` before each
invocation ensures that it uses the same version of GHC as is on the `PATH`.
Expand All @@ -99,7 +102,7 @@ Notes:
So a more robust way to call `doctest` is as follows:

```
cabal install doctest --overwrite-policy=always && cabal build && cabal repl --build-depends=QuickCheck --build-depends=template-haskell --with-ghc=doctest
cabal install doctest --overwrite-policy=always && cabal build && cabal repl --build-depends=QuickCheck --build-depends=template-haskell --with-ghc=doctest --repl-options='-w -Wdefault'
```

(This is what you want to use on CI.)
Expand Down

0 comments on commit a88ff8a

Please sign in to comment.