improve documentation of clientPublishPost

src/Hash2Pub/PostService.hs

@@ -450,11 +450,11 @@ clientUnsubscribeFrom serv tag = do
 -- the post to the responsible relays.
 -- As the initial publishing isn't done by a specific relay (but *to* a specific relay
 -- instead), the function does *not* take a PostService as argument.
-clientPublishPost :: HTTP.Manager   -- for better performance, a shared HTTP manager has to be provided
-                  -> String         -- hostname
-                  -> Int            -- port
-                  -> PostContent    -- post content
-                  -> IO (Either String ())  -- error or success
+clientPublishPost :: HTTP.Manager   -- ^ for better performance, a shared HTTP manager has to be provided
+                  -> String         -- ^ hostname
+                  -> Int            -- ^ port
+                  -> PostContent    -- ^ post content
+                  -> IO (Either String ())  -- ^ error or success
 clientPublishPost httpman hostname port postC = do
     resp <- runClientM (postInboxClient postC) (mkClientEnv httpman (BaseUrl Http hostname port ""))
     pure . bimap show (const ()) $ resp