Improve documentation for ClusterManagers, tighten function types #17688
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Cleaned up formatting and wording, documented `Base.process_messages` a little, made `incoming` a `Bool` (since `message_handler_loop` requires this anyway).
kshyatt
added
docs
AsyncStream hasn't existed since #12839, nearly a year ago. Updated the parallel docs to reflect this fact and to correspond more closely with the current state of `multi.jl` and `managers.jl`.
|
thanks for correcting these. I had no idea we were referencing |
|
|
| .. code-block:: julia | ||
|
|
||
| sshflags=`-i /home/foo/bar.pem` | ||
| * ``sshflags``\ : specifies additional ssh options, e.g.:: sshflags=``-i /home/foo/bar.pem`` |
There was a problem hiding this comment.
formatting looks wrong here
|
Any thoughts on the most recent changes @amitmurthy, @tkelman, @mweastwood ? |
|
LGTM. One other feedback would be to rearrange / further split up sections in the rst (can also be done in a different PR). Currently we have A suggested reorg : |
|
@amitmurthy in that case I will merge in the morning and open a new PR sometime soon. I have a pair of fresh eyes reading the parallel docs for things confusing to newbies as well :) |
| If the master process fails to establish a connection with a newly launched worker within | ||
| 60.0 seconds, the worker treats it as a fatal situation and terminates. | ||
| This timeout can be controlled via environment variable `JULIA_WORKER_TIMEOUT`. | ||
| The value of JULIA_WORKER_TIMEOUT` on the master process specifies the number of seconds a |
mfasi
pushed a commit
to mfasi/julia
that referenced
this pull request
Sep 5, 2016
…liaLang#17688) * Improve documentation for ClusterManagers, tighten function types Cleaned up formatting and wording, documented `Base.process_messages` a little, made `incoming` a `Bool` (since `message_handler_loop` requires this anyway). * Moved docs out of HelpDB, got rid of references to AsyncStream. AsyncStream hasn't existed since JuliaLang#12839, nearly a year ago. Updated the parallel docs to reflect this fact and to correspond more closely with the current state of `multi.jl` and `managers.jl`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Cleaned up formatting and wording, documented
Base.process_messagesalittle, made
incomingaBool(sincemessage_handler_looprequiresthis anyway).