Add more documentation

This commit is contained in:
Victor Denisov 2016-08-22 21:24:06 -07:00
parent 399e2c3443
commit 5812753217

View file

@ -22,7 +22,7 @@ module Database.MongoDB.Query (
insert, insert_, insertMany, insertMany_, insertAll, insertAll_, insert, insert_, insertMany, insertMany_, insertAll, insertAll_,
-- ** Update -- ** Update
save, replace, repsert, upsert, Modifier, modify, updateMany, updateAll, save, replace, repsert, upsert, Modifier, modify, updateMany, updateAll,
UpdateResult, UpdateOption(..), UpdateResult(..), UpdateOption(..), Upserted(..),
-- ** Delete -- ** Delete
delete, deleteOne, deleteMany, deleteAll, DeleteResult, DeleteOption(..), delete, deleteOne, deleteMany, deleteAll, DeleteResult, DeleteOption(..),
-- * Read -- * Read
@ -151,7 +151,8 @@ type GetLastError = Document
data UpdateResult = UpdateResult data UpdateResult = UpdateResult
{ nMatched :: Int { nMatched :: Int
, nModified :: Maybe Int -- Mongodb server before 2.6 doesn't allow to calculate this value. It's Nothing if we fail to do so , nModified :: Maybe Int
-- ^ Mongodb server before 2.6 doesn't allow to calculate this value. This field is nothing if we can't calculate the number of modified documents.
, upserted :: [Upserted] , upserted :: [Upserted]
, writeErrors :: [WriteError] , writeErrors :: [WriteError]
} deriving Show } deriving Show