about summary refs log tree commit diff
diff options
context:
space:
mode:
authorsternenseemann <0rpkxez4ksa01gb3typccl0i@systemli.org>2021-03-16 21:26:34 +0100
committersternenseemann <0rpkxez4ksa01gb3typccl0i@systemli.org>2021-03-16 21:26:34 +0100
commit77fb1cef6a1f68ece5d8b755b495a05d529dedcf (patch)
treeffb0c5f5e8483f360049fa79ea1fec9affb7d56b
parentcf648932c00a17d91f69c29151eea11a7c499c2b (diff)
doc(Network.Gopher): link gophermap module in appropiate section
-rw-r--r--src/Network/Gopher.hs5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/Network/Gopher.hs b/src/Network/Gopher.hs
index c0bc6a6..7feeffe 100644
--- a/src/Network/Gopher.hs
+++ b/src/Network/Gopher.hs
@@ -75,6 +75,7 @@ module Network.Gopher (
   -- ** Networking
   , setupGopherSocket
   -- ** Gophermaps
+  -- $gophermapDoc
   , gophermapToDirectoryResponse
   , Gophermap
   , GophermapEntry (..)
@@ -171,6 +172,10 @@ type GopherLogHandler = GopherLogLevel -> GopherLogStr -> IO ()
 -- >>> hideSensitive $ "Look at my " <> makeSensitive "secret"
 -- "Look at my [redacted]"
 
+-- $gophermapDoc
+-- Helper functions for converting 'Gophermap's into 'MenuResponse's.
+-- For parsing gophermap files, refer to "Network.Gopher.Util.Gophermap".
+
 data GopherRequest
   = GopherRequest
   { requestRawSelector  :: ByteString