aboutsummaryrefslogtreecommitdiff
path: root/doc/common-errors.rst
diff options
context:
space:
mode:
authorBen Gamari <ben@smart-cactus.org>2022-04-25 16:24:31 -0400
committerBen Gamari <ben@smart-cactus.org>2022-04-25 16:24:31 -0400
commit70b83bc5fa944f17f1423c4c94a38b82bdfe1ccd (patch)
treeb0c43a5ac7cf53b4832d1f34ebfa57042a422398 /doc/common-errors.rst
parent24208496649a02d5f87373052c430ea4a97842c5 (diff)
parent0c19a8847844a4a45b9fe7c115effcec461cfe5c (diff)
Merge remote-tracking branch 'upstream/ghc-9.2' into ghc-head
Diffstat (limited to 'doc/common-errors.rst')
-rw-r--r--doc/common-errors.rst19
1 files changed, 19 insertions, 0 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