fix some haddock problems

Unfortunately it seem (emperically) that haddock only allows the pipe
character on the first line of document, not on every line. Or more
literally, it allows them, but treats them as part of the output to
display in the rendered document.

Fixing that, it also wasn't happy about not introducing the code block
as a new paragraph.
This commit is contained in:
Scott R. Parish 2010-02-06 14:52:09 -06:00
parent 34b4d22856
commit 8f972f6dda

View file

@ -570,9 +570,9 @@ addUser c db user pass = do
return doc' return doc'
-- | Conveniently stores the /BsonDoc/ to the /FullCollection/ -- | Conveniently stores the /BsonDoc/ to the /FullCollection/
-- | if there is an _id present in the /BsonDoc/ then it already has -- if there is an _id present in the /BsonDoc/ then it already has
-- | a place in the DB, so we update it using the _id, otherwise -- a place in the DB, so we update it using the _id, otherwise
-- | we insert it -- we insert it
save :: Connection -> FullCollection -> BsonDoc -> IO RequestID save :: Connection -> FullCollection -> BsonDoc -> IO RequestID
save c fc doc = save c fc doc =
case Map.lookup (s2L "_id") doc of case Map.lookup (s2L "_id") doc of
@ -580,11 +580,13 @@ save c fc doc =
Just obj -> update c fc [UFUpsert] (toBsonDoc [("_id", obj)]) doc Just obj -> update c fc [UFUpsert] (toBsonDoc [("_id", obj)]) doc
-- | Use this in the place of the query portion of a select type query -- | Use this in the place of the query portion of a select type query
-- | This uses javascript and a scope supplied by a /BsonDoc/ to evaluate -- This uses javascript and a scope supplied by a /BsonDoc/ to evaluate
-- | documents in the database for retrieval. -- documents in the database for retrieval.
-- | Example: --
-- | > findOne conn mycoll $ whereClause "this.name == (name1 + name2)" -- Example:
-- | > (toBsonDoc [("name1", toBson "mar"), ("name2", toBson "tha")]) --
-- > findOne conn mycoll $ whereClause "this.name == (name1 + name2)"
-- > (toBsonDoc [("name1", toBson "mar"), ("name2", toBson "tha")])
whereClause :: String -> BsonDoc -> BsonDoc whereClause :: String -> BsonDoc -> BsonDoc
whereClause qry scope = toBsonDoc [("$where", (BsonCodeWScope (s2L qry) scope))] whereClause qry scope = toBsonDoc [("$where", (BsonCodeWScope (s2L qry) scope))]