haskell-distributed / haskell-distributed/distributed-process
Add more docs for createTransport
Open
Nobody has claimed this yet.
network-transport-tcp
- Dominant language
- Haskell
- Stars
- 751
- Forks
- 99
- Avg merge
- 45m
- Merged PRs (30d)
- 2
Description
Refers to: https://github.com/haskell-distributed/network-transport-tcp/pull/50
It is not clear how to migrate from previous version to new createTransport. What should I pass to (ServiceName -> (HostName, ServiceName)) to preserve old behavior?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked network-transport-tcp pull request 50 and the createTransport entry point, then trace how the (ServiceName -> (HostName, ServiceName)) argument relates to the previous version. Document the value that preserves old behavior and add a migration explanation; done means a newcomer can choose the argument without ambiguity.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- distributed-systems, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100