From ff6c624da2e0ec9fa766eb866075176cde4e0e39 Mon Sep 17 00:00:00 2001 From: CGenie Date: Mon, 31 May 2021 09:02:13 +0200 Subject: Add page about common errors (#1396) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 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 --- doc/common-errors.rst | 19 +++++++++++++++++++ doc/index.rst | 1 + haddock-api/.hspec-failures | 1 - 3 files changed, 20 insertions(+), 1 deletion(-) create mode 100644 doc/common-errors.rst delete mode 100644 haddock-api/.hspec-failures 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 -- cgit v1.2.3