Skip to content
Snippets Groups Projects
Commit 51d991d7 authored by Iustin Pop's avatar Iustin Pop
Browse files

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: default avatarIustin Pop <iustin@google.com>
Reviewed-by: default avatarMichael Hanselmann <hansmi@google.com>
parent 32f2e1e1
No related branches found
No related tags found
No related merge requests found
......@@ -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.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment