aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCGenie <cgenie@pm.me>2021-05-31 09:02:13 +0200
committerGitHub <noreply@github.com>2021-05-31 09:02:13 +0200
commitff6c624da2e0ec9fa766eb866075176cde4e0e39 (patch)
treea914552e9e81a5d5c757b2c36fe67aa400f47ba1
parentda79aea71b9cc7ee6e56792b4716be0ff11a09fb (diff)
Add page about common errors (#1396)
* Update index.rst Common errors page * Create common-errors.rst * Update common-errors.rst * Use GHC 9.2 in CI runner (#1378) * [haddock-api] remove .hspec-failures Co-authored-by: Hécate Moonlight <Kleidukos@users.noreply.github.com>
-rw-r--r--doc/common-errors.rst19
-rw-r--r--doc/index.rst1
-rw-r--r--haddock-api/.hspec-failures1
3 files changed, 20 insertions, 1 deletions
diff --git a/doc/common-errors.rst b/doc/common-errors.rst
new file mode 100644
index 00000000..9afa4ea7
--- /dev/null
+++ b/doc/common-errors.rst
@@ -0,0 +1,19 @@
+Common Errors
+=============
+
+``parse error on input ‘-- | xxx’``
+-----------------------------------
+
+This is probably caused by the ``-- | xxx`` comment not following a declaration. I.e. use ``-- xxx`` instead. See :ref:`top-level-declaration`.
+
+``parse error on input ‘-- $ xxx’``
+----------------------------------
+
+You've probably commented out code like::
+
+ f x
+ $ xxx
+
+``-- $`` is a special syntax for named chunks, see :ref:`named-chunks`. You can fix this by escaping the ``$``::
+
+ -- \$ xxx
diff --git a/doc/index.rst b/doc/index.rst
index dc30c45f..d800a2b9 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -12,6 +12,7 @@ Contents:
intro
invoking
markup
+ common-errors
Indices and tables
diff --git a/haddock-api/.hspec-failures b/haddock-api/.hspec-failures
deleted file mode 100644
index 55d67884..00000000
--- a/haddock-api/.hspec-failures
+++ /dev/null
@@ -1 +0,0 @@
-FailureReport {failureReportSeed = 630888988, failureReportMaxSuccess = 100, failureReportMaxSize = 100, failureReportMaxDiscardRatio = 10, failureReportPaths = []} \ No newline at end of file