doctest-extract 0.1.1 → 0.1.1.1

raw patch · 2 files changed

+32/−8 lines, 2 files

Files

• ReadMe.md +28/−0
• doctest-extract.cabal +4/−8

@@ -0,0 +1,28 @@+# Known Issues++*   For compatibility with original `doctest` parser+    you cannot write++    ~~~~+    {-# LANGUAGE MyPreferredExtension #-}+    ~~~~++    Instead you must write++    ~~~~+    :set -XMyPreferredExtension+    ~~~~++* In Literal Haskell files+  only `\\begin{code} ... \\end{code}` blocks are scanned,+  but not bird style code blocks.++* `prop>` does not support multi-line code,+  because both original `doctest` and `haddock` do not support it.++* IO tests are not supported as `doctest` examples, so far.+  We need a syntactic distinction for IO tests,+  because `doctest-extract` does not employ a type-checker.+  We could mark IO tests+  with a specific `id` function, as in `ioTest $ runMyTest`+  or a type annotation, as in `runMyTest :: IO ()`.

@@ -1,6 +1,6 @@ Cabal-Version:  2.2 Name:           doctest-extract-Version:        0.1.1+Version:        0.1.1.1 License:        BSD-3-Clause License-File:   LICENSE Author:         Henning Thielemann <haskell@henning-thielemann.de>@@ -74,21 +74,17 @@   * You need tools additional to @Cabal@, e.g. @make@ and a @Makefile@,     in order generate test modules.   .-  Known Problems:-  .-  * In Literal Haskell files-    only @\\begin{code} ... \\end{code}@ blocks are scanned,-    but not bird style code blocks.-  .   See packages @utility-ht@, @apportionment@ or @pathtype@ for packages   with working setups of @doctest-extract@.   .   Alternatives: @cabal-docspec@, @cabal-doctest@ Tested-With:    GHC==7.4.2, GHC==8.6.5 Build-Type:     Simple+Extra-Source-Files:+  ReadMe.md  Source-Repository this-  Tag:         0.1.1+  Tag:         0.1.1.1   Type:        darcs   Location:    https://hub.darcs.net/thielema/doctest-extract/