Wenn ich die Linie
habe %Vor%im Dokumentationsteil (Beschreibung) der .cabal-Datei bekomme ich die Fehlermeldung
%Vor%beim Ausführen
%Vor% aber wenn ich die {
und }
loswirde, funktioniert alles gut. Gibt es eine Möglichkeit, {}
zu umgehen, damit sie in der Beschreibung verwendet werden können?
Haddock hat zwei Syntaxen für Codeblöcke - die Syntax, die Blöcke mit @
begrenzt, ermöglicht die Verwendung von HTML-Escapes, die zum Einbetten von Zeichen verwendet werden können, die der Parser von Cabal nicht verarbeiten kann.
Leider scheint Cabal den führenden Leerraum von @
-begrenzten Blöcken zu entfernen, daher müssen Sie auch Zeilen mit Leerzeichen mit einem HTML-codierten Leerzeichen  
voranstellen.
Hier ist ein Beispiel:
%Vor%Was zu:
machtMein Paket mit einem Codebeispiel!
%Vor%
OPTIONS_GHC
selbst ist nicht veraltet (Sie würden dies zum Beispiel verwenden, um bestimmte Build-Optionen zu aktivieren), aber es wird nicht als gute Praxis angesehen, Sprachfunktionen zu aktivieren / deaktivieren. Verwenden Sie stattdessen {-# LANGUAGE ... #-}
Pragmas.
z.B. {-# LANGUAGE TemplateHaskell, ForeignFunctionInterface, RankNTypes #-}
Es wird auch als schlechte Form angesehen, das allumfassende -fglasgow-exts
zu verwenden. Es ist besser, nur die Erweiterungen hinzuzufügen, die Sie benötigen, und auf diese Weise ist es klarer, welche für jeden, der mit Ihrem Code neu ist, erforderlich sind.