Skip to content

Commit 824d191

Browse files
authored
Merge pull request #348 from phadej/gadt-haddock
Document GADT constructors
2 parents 979fb5a + ee6efdc commit 824d191

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/GitHub/Data/Request.hs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ data CommandMethod a where
6161
Post :: CommandMethod a
6262
Patch :: CommandMethod a
6363
Put :: CommandMethod a
64+
65+
-- | Put requests, where we don't care about response's body
6466
Put' :: CommandMethod ()
6567
Delete :: CommandMethod ()
6668
deriving (Typeable)
@@ -146,6 +148,8 @@ data Request (k :: RW) a where
146148
SimpleQuery :: FromJSON a => SimpleRequest k a -> Request k a
147149
StatusQuery :: StatusMap a -> SimpleRequest k () -> Request k a
148150
HeaderQuery :: FromJSON a => Types.RequestHeaders -> SimpleRequest k a -> Request k a
151+
152+
-- | Redirect query is /some/ query where we expect status 302 response with @Location@ header.
149153
RedirectQuery :: SimpleRequest k () -> Request k URI
150154
deriving (Typeable)
151155

0 commit comments

Comments
 (0)