Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated MANUAL.md #121

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+3 −3
Open

Updated MANUAL.md #121

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions cabal-docspec/MANUAL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ DESCRIPTION
*cabal-docspec* is a doctest runner closely integrated with *cabal-install*.
In common scenarios cabal-docspec is able to self-configure using cabal-install generated metadata (*plan.json*).
Another important difference is that cabal-docspec
doesn't depend on *ghc* library, but rather invoke the *ghci* executable.
doesn't depend on *ghc* library, but rather invokes the *ghci* executable.

cabal-docspec doesn't use GHC to parse input files,
but rather relies on *haskell-lexer* for comment extraction.
Expand All @@ -42,7 +42,7 @@ However, in this list we mostly only list and show the --option version of them.

**\--ghc**

: Indicate the used compiler is GHC. Currently this options is no-op.
: Indicate to use the GHC compiler. (Currently this options is no-op!)

**\--cabal-plan**
: Read *plan.json* produced by cabal-install to find out project packages and their dependencies.
Expand Down Expand Up @@ -150,7 +150,7 @@ However, in this list we mostly only list and show the --option version of them.
CABAL FIELDS
============

It' is possible to provide cabal-docspec configuration
It is possible to provide cabal-docspec configuration
through fields in a .cabal file.

**x-docspec-options:** *[OPTION]*...
Expand Down