From 51d991d78d333aa911bdc192acdfc4514feeb478 Mon Sep 17 00:00:00 2001
From: Iustin Pop <iustin@google.com>
Date: Mon, 19 Nov 2012 17:07:01 +0100
Subject: [PATCH] Fix docstrings for the Filter type
While looking at the opcode docs and clicking accidentally on the
filter type, I saw that the haddock formatting is broken due to
non-escaped use of special chars. Let's convert the ascii-like
formatting to haddock, and have nicer apidoc.
Signed-off-by: Iustin Pop <iustin@google.com>
Reviewed-by: Michael Hanselmann <hansmi@google.com>
---
htools/Ganeti/Query/Language.hs | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/htools/Ganeti/Query/Language.hs b/htools/Ganeti/Query/Language.hs
index bb2c07ea0..26155f25e 100644
--- a/htools/Ganeti/Query/Language.hs
+++ b/htools/Ganeti/Query/Language.hs
@@ -127,17 +127,17 @@ type Fields = [ String ]
-- getters, etc.
data Filter a
= EmptyFilter -- ^ No filter at all
- | AndFilter [ Filter a ] -- ^ & [<expression>, ...]
- | OrFilter [ Filter a ] -- ^ | [<expression>, ...]
- | NotFilter (Filter a) -- ^ ! <expression>
- | TrueFilter a -- ^ ? <field>
- | EQFilter a FilterValue -- ^ (=|!=) <field> <value>
- | LTFilter a FilterValue -- ^ < <field> <value>
- | GTFilter a FilterValue -- ^ > <field> <value>
- | LEFilter a FilterValue -- ^ <= <field> <value>
- | GEFilter a FilterValue -- ^ >= <field> <value>
- | RegexpFilter a FilterRegex -- ^ =~ <field> <regexp>
- | ContainsFilter a FilterValue -- ^ =[] <list-field> <value>
+ | AndFilter [ Filter a ] -- ^ @&@ [/expression/, ...]
+ | OrFilter [ Filter a ] -- ^ @|@ [/expression/, ...]
+ | NotFilter (Filter a) -- ^ @!@ /expression/
+ | TrueFilter a -- ^ @?@ /field/
+ | EQFilter a FilterValue -- ^ @(=|!=)@ /field/ /value/
+ | LTFilter a FilterValue -- ^ @<@ /field/ /value/
+ | GTFilter a FilterValue -- ^ @>@ /field/ /value/
+ | LEFilter a FilterValue -- ^ @<=@ /field/ /value/
+ | GEFilter a FilterValue -- ^ @>=@ /field/ /value/
+ | RegexpFilter a FilterRegex -- ^ @=~@ /field/ /regexp/
+ | ContainsFilter a FilterValue -- ^ @=[]@ /list-field/ /value/
deriving (Show, Read, Eq)
-- | Serialiser for the 'Filter' data type.
--
GitLab