-
Notifications
You must be signed in to change notification settings - Fork 24
Replace a few references to platform to the now more specific projects. #29
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great, thank you @teh! We've been discussing moving some of this to readthedocs, so the fixes should help with that too (though I'm seeing some rendering issues, but I think these were present already).
documentation.md
Outdated
*task layer*, but takes a very different approach to that described | ||
in the original paper and implemented by the [remote][remote] package. In particular, | ||
we diverge from the original design and defer to many of the principles | ||
defined by Erlang's [Open Telecom Platform][OTP], taking in some well established | ||
Haskell concurrency design patterns along the way. | ||
|
||
In fact, [distributed-process-platform][distributed-process-platform] does not really consider the | ||
In fact, [distributed-process-async][distributed-process-async] does not really consider the | ||
*task layer* in great detail. We provide an API comparable to remote's | ||
`Promise` in `Control.Distributed.Process.Platform.Async`. This API however, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/.Platform//
@@ -427,14 +427,14 @@ domain was more *haskell-ish* than working with bare send and receive primitives | |||
The `Async` sub-package also provides a type safe interface for receiving data, | |||
although it is limited to running a computation and waiting for its result. | |||
|
|||
The [Control.Distributed.Processes.Platform.ManagedProcess][d-p-platform-ManagedProcess] API provides a | |||
The [Control.Distributed.Processes.Platform.ManagedProcess][d-p-client-server-ManagedProcess] API provides a |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/.Platform//
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
@@ -19,8 +18,6 @@ Documentation is available on this site for HEAD, or | |||
[hackage](http://hackage.haskell.org/package/distributed-process) for the current and preceding versions of | |||
each library. | |||
|
|||
### <a href="/rss.xml"><img src="/img/feed-icon-28x28.png"></a> Recent Activity <a class="pull-right" href="http://hackage.haskell.org/platform" ><img src="http://hackage.haskell.org/platform/icons/button-64.png"></a> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why are we getting rid of this bit?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah sorry, only meant to remove the link to haskell-platform. The button image is no longer there and I couldn't find a good replacement.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay that's fine.
team.md
Outdated
@@ -27,7 +27,7 @@ of Cloud Haskell as a whole. [Edsko De Vries][13], a member of Well-Typed and th | |||
author of much of the new implementation we have today, is still closely involved | |||
as well. | |||
|
|||
[Tim][6] is the primary author and maintainer of [disributed-process-platform][8]; | |||
[Tim][6] is the primary author and maintainer of [disributed-process][8]; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's remove this part, firstly it's not true (I'm only one of several authors and committers, and distributed-process is now under @facundominguez's maintainership), secondly we're not listing all the libraries. I think we just s/[distributed-process][0],numerous libraries in (... an effort to...)/
thoughts...?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think if we will add a paragraph about platform and core - it will be easy to write. Something like:
Most of the packages are maintained my the haskell-distributed organization(?) that with people from Well Typed, Tweag, and (other companies that are involved) and individuals (names).
Main maintaiters are @facundominguez maintains core packages, @hyperthunk maintains platform packages.
Some libraries are maintained my third parties, most notably d-p-p2p.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
@@ -366,17 +366,17 @@ process. The `ProcessInfo` type it returns contains the local node id and a list | |||
registered names, monitors and links for the process. The call returns `Nothing` if the | |||
process in question is not alive. | |||
|
|||
### Monad Transformer Stacks | |||
### Monad Transformer Stacks |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should add an issue (if not fixing here) to point out the risks of this approach - @qnikst can you advise the right text to put in please?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Everything is ok, until you make an instance of BaseControl
to Process monad. And this is 3rd party package, that I hope mentions possible problems
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure what this means, needs a separate doc update from you I think
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay let's do that separately, I'll open an issue.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some minor comments.
documentation.md
Outdated
@@ -31,7 +31,7 @@ Cloud Haskell comprises the following components, some of which are complete, | |||
others experimental. | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to put among the lines that Cloud Haskell consists of 2 (3) big parts:
- Core package
distributed-process
itself. Using this package on it's own may be enough to write any
functionality. This package considered most stable. - Platform packages. Platform packages are built on the top of core packages and are intended to provide an implementation of patterns that are similar to OTP library (is it library?) in Erlang.
3 because we have also network-transport layer for communication between nodes (though this may be ommited).
Also there is d-p-simplelocalnet, and d-p-p2p that are not core, but neither platform.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done, PTAL.
team.md
Outdated
@@ -27,7 +27,7 @@ of Cloud Haskell as a whole. [Edsko De Vries][13], a member of Well-Typed and th | |||
author of much of the new implementation we have today, is still closely involved | |||
as well. | |||
|
|||
[Tim][6] is the primary author and maintainer of [disributed-process-platform][8]; | |||
[Tim][6] is the primary author and maintainer of [disributed-process][8]; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think if we will add a paragraph about platform and core - it will be easy to write. Something like:
Most of the packages are maintained my the haskell-distributed organization(?) that with people from Well Typed, Tweag, and (other companies that are involved) and individuals (names).
Main maintaiters are @facundominguez maintains core packages, @hyperthunk maintains platform packages.
Some libraries are maintained my third parties, most notably d-p-p2p.
@@ -366,17 +366,17 @@ process. The `ProcessInfo` type it returns contains the local node id and a list | |||
registered names, monitors and links for the process. The call returns `Nothing` if the | |||
process in question is not alive. | |||
|
|||
### Monad Transformer Stacks | |||
### Monad Transformer Stacks |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Everything is ok, until you make an instance of BaseControl
to Process monad. And this is 3rd party package, that I hope mentions possible problems
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM - @qnikst ?
No description provided.