improve documentation of clientPublishPost
This commit is contained in:
parent
24088581fe
commit
32734102cd
|
@ -450,11 +450,11 @@ clientUnsubscribeFrom serv tag = do
|
||||||
-- the post to the responsible relays.
|
-- the post to the responsible relays.
|
||||||
-- As the initial publishing isn't done by a specific relay (but *to* a specific relay
|
-- 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.
|
-- instead), the function does *not* take a PostService as argument.
|
||||||
clientPublishPost :: HTTP.Manager -- for better performance, a shared HTTP manager has to be provided
|
clientPublishPost :: HTTP.Manager -- ^ for better performance, a shared HTTP manager has to be provided
|
||||||
-> String -- hostname
|
-> String -- ^ hostname
|
||||||
-> Int -- port
|
-> Int -- ^ port
|
||||||
-> PostContent -- post content
|
-> PostContent -- ^ post content
|
||||||
-> IO (Either String ()) -- error or success
|
-> IO (Either String ()) -- ^ error or success
|
||||||
clientPublishPost httpman hostname port postC = do
|
clientPublishPost httpman hostname port postC = do
|
||||||
resp <- runClientM (postInboxClient postC) (mkClientEnv httpman (BaseUrl Http hostname port ""))
|
resp <- runClientM (postInboxClient postC) (mkClientEnv httpman (BaseUrl Http hostname port ""))
|
||||||
pure . bimap show (const ()) $ resp
|
pure . bimap show (const ()) $ resp
|
||||||
|
|
Loading…
Reference in a new issue