setup doctests
commit857823d6bed28418b9f80b6eb92e7727c56bd56a
authorEitan Chatav <eitan@Eitans-MacBook-Pro.local>
dateSat 6 Apr 2019, 13:55 (8 years ago)
parenta1f8334
squeal-postgresql/src/Squeal/PostgreSQL/Definition.hs+3
@@ -104,6 +104,9 @@ import Squeal.PostgreSQL.Query
104104import Squeal.PostgreSQL.Render
105105import Squeal.PostgreSQL.Schema
106106
107+-- $setup
108+-- >>> import Squeal.PostgreSQL
109+
107110{-----------------------------------------
108111statements
109112-----------------------------------------}
squeal-postgresql/src/Squeal/PostgreSQL/Expression.hs+3
@@ -126,6 +126,9 @@ import Squeal.PostgreSQL.PG
126126import Squeal.PostgreSQL.Render
127127import Squeal.PostgreSQL.Schema
128128
129+-- $setup
130+-- >>> import Squeal.PostgreSQL
131+
129132{-----------------------------------------
130133column expressions
131134-----------------------------------------}
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Aggregate.hs+4−1
@@ -20,7 +20,7 @@ module Squeal.PostgreSQL.Expression.Aggregate
2020 ) where
2121
2222import Control.DeepSeq
23−import Data.ByteString
23+import Data.ByteString (ByteString)
2424import Data.Kind
2525import GHC.TypeLits
2626
@@ -33,6 +33,9 @@ import Squeal.PostgreSQL.List
3333import Squeal.PostgreSQL.Render
3434import Squeal.PostgreSQL.Schema
3535
36+-- $setup
37+-- >>> import Squeal.PostgreSQL
38+
3639{- |
3740`Aggregate` functions compute a single result from a set of input values.
3841`Aggregate` functions can be used as `GroupedBy` `Expression`s as well
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Collection.hs+3
@@ -34,6 +34,9 @@ import Squeal.PostgreSQL.List
3434import Squeal.PostgreSQL.Render
3535import Squeal.PostgreSQL.Schema
3636
37+-- $setup
38+-- >>> import Squeal.PostgreSQL
39+
3740-- | >>> printSQL $ array [null_, false, true]
3841-- ARRAY[NULL, FALSE, TRUE]
3942array
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Comparison.hs+3
@@ -32,6 +32,9 @@ import Squeal.PostgreSQL.Expression.Logic
3232import Squeal.PostgreSQL.Render
3333import Squeal.PostgreSQL.Schema
3434
35+-- $setup
36+-- >>> import Squeal.PostgreSQL
37+
3538-- | Comparison operations like `.==`, `./=`, `.>`, `.>=`, `.<` and `.<=`
3639-- will produce @NULL@s if one of their arguments is @NULL@.
3740--
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Math.hs+4
@@ -17,6 +17,10 @@ import Squeal.PostgreSQL.Expression
1717import Squeal.PostgreSQL.List
1818import Squeal.PostgreSQL.Schema
1919
20+-- $setup
21+-- >>> import Squeal.PostgreSQL
22+-- >>> import Squeal.PostgreSQL.Render
23+
2024-- | >>> :{
2125-- let
2226-- expression :: Expr (null 'PGfloat4)
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Null.hs+3
@@ -20,6 +20,9 @@ import Squeal.PostgreSQL.Expression.Logic
2020import Squeal.PostgreSQL.Render
2121import Squeal.PostgreSQL.Schema
2222
23+-- $setup
24+-- >>> import Squeal.PostgreSQL
25+
2326-- | analagous to `Nothing`
2427--
2528-- >>> printSQL null_
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Text.hs+4
@@ -15,6 +15,10 @@ module Squeal.PostgreSQL.Expression.Text
1515import Squeal.PostgreSQL.Expression
1616import Squeal.PostgreSQL.Schema
1717
18+-- $setup
19+-- >>> import Squeal.PostgreSQL
20+-- >>> import Squeal.PostgreSQL.Render
21+
1822-- | >>> printSQL $ lower "ARRRGGG"
1923-- lower(E'ARRRGGG')
2024lower :: null 'PGtext :--> null 'PGtext
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Time.hs+3
@@ -34,6 +34,9 @@ import Squeal.PostgreSQL.Expression
3434import Squeal.PostgreSQL.Render
3535import Squeal.PostgreSQL.Schema
3636
37+-- $setup
38+-- >>> import Squeal.PostgreSQL
39+
3740-- | >>> printSQL currentDate
3841-- CURRENT_DATE
3942currentDate :: Expr (null 'PGdate)
squeal-postgresql/src/Squeal/PostgreSQL/Manipulation.hs+3
@@ -71,6 +71,9 @@ import Squeal.PostgreSQL.Render
7171import Squeal.PostgreSQL.Query
7272import Squeal.PostgreSQL.Schema
7373
74+-- $setup
75+-- >>> import Squeal.PostgreSQL
76+
7477{- |
7578A `Manipulation` is a statement which may modify data in the database,
7679but does not alter its schemas. Examples are inserts, updates and deletes.
squeal-postgresql/src/Squeal/PostgreSQL/PQ.hs+3
@@ -103,6 +103,9 @@ import qualified Control.Monad.Trans.Writer.Strict as Strict
103103import qualified Control.Monad.Trans.RWS.Lazy as Lazy
104104import qualified Control.Monad.Trans.RWS.Strict as Strict
105105
106+-- $setup
107+-- >>> import Squeal.PostgreSQL
108+
106109{- | Makes a new connection to the database server.
107110
108111This function opens a new database connection using the parameters taken
squeal-postgresql/src/Squeal/PostgreSQL/Query.hs+3
@@ -122,6 +122,9 @@ import Squeal.PostgreSQL.PG
122122import Squeal.PostgreSQL.Render
123123import Squeal.PostgreSQL.Schema
124124
125+-- $setup
126+-- >>> import Squeal.PostgreSQL
127+
125128{- |
126129The process of retrieving or the command to retrieve data from a database
127130is called a `Query`. Let's see some examples of queries.