1861943 · distributed-process

git.iko.soy/distributed-process

Fix docstring for `register`.

It said "asynchronous", when clearly "synchronous" was meant. From the moment that word is said, the second sentence becomes redundant, and arguably exposes unnecessary implementation detail to the user.

commit18619433d038918a1cdd488b4c95ebd05c962e1d authorMathieu Boespflug <m@tweag.io> dateSun 7 Dec 2014, 19:16 (12 years ago) parentfc0a1cc

1 file changed+3−5

compare with master

unifiedsplit

src/Control/Distributed/Process/Internal/Primitives.hs+3−5

src/Control/Distributed/Process/Internal/Primitives.hs+3−5

@@ -1025,11 +1025,9 @@ say string = do

10251025-- Registry --

10261026--------------------------------------------------------------------------------

10271027

1028−-- | Register a process with the local registry (asynchronous).

1029−-- This version will wait until a response is gotten from the

1030−-- management process. The name must not already be registered.

1031−-- The process need not be on this node.

1032−-- A bad registration will result in a 'ProcessRegistrationException'

1028+-- | Register a process with the local registry (synchronous). The name must not

1029+-- already be registered. The process need not be on this node. A bad

1030+-- registration will result in a 'ProcessRegistrationException'

10331031--

10341032-- The process to be registered does not have to be local itself.

10351033register :: String -> ProcessId -> Process ()