From 148bec7f0a1e7d9fe890f74c03fce0bc6eceffd3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jan=20Hamal=20Dvo=C5=99=C3=A1k?= <mordae@anilinux.org>
Date: Tue, 7 May 2019 10:18:33 +0200
Subject: [PATCH] Add missing documentation strings
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Jan Hamal Dvořák <mordae@anilinux.org>
---
lib/Web/Hikaru/Action.hs | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/lib/Web/Hikaru/Action.hs b/lib/Web/Hikaru/Action.hs
index 7fa6ff0..1a3ae89 100644
--- a/lib/Web/Hikaru/Action.hs
+++ b/lib/Web/Hikaru/Action.hs
@@ -334,6 +334,9 @@ where
getPathInfo = pathInfo <$> getRequest
+ -- |
+ -- Obtain request path as an unsplit 'Text'.
+ --
getPathInfoRaw :: (MonadAction m) => m Text
getPathInfoRaw = cs <$> rawPathInfo <$> getRequest
@@ -976,6 +979,10 @@ where
-- Finalizing --------------------------------------------------------------
+ -- |
+ -- Register an IO action to run once the request is either handler
+ -- or fails with an error.
+ --
registerFinalizer :: (MonadAction m) => IO a -> m ()
registerFinalizer fin = do
modifyActionField aeFinalize (fin >>)
--
GitLab