Move some spawn related macro docs out of HelpDB #22573
Merged
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
kshyatt
added
docs
ararslan
reviewed
Jun 27, 2017
base/distributed/macros.jl
Outdated
| """ | ||
| @spawn | ||
|
|
||
| Creates a closure around an expression and runs it on an automatically-chosen process, |
There was a problem hiding this comment.
Perhaps an opportunity to imperative-ize these?
There was a problem hiding this comment.
And why not add some examples while we're here...
tkelman
reviewed
Jun 28, 2017
base/distributed/macros.jl
Outdated
| @@ -30,8 +47,20 @@ end | |||
| """ | |||
| @spawnat | |||
|
|
|||
| Accepts two arguments, `p` and an expression. A closure is created around the expression and | |||
| run asynchronously on process `p`. Returns a [`Future`](@ref) to the result. | |||
| Create a closure is created around the expression and run the closure | |||
Sacha0
reviewed
Jun 28, 2017
|
|
||
| Create a closure around an expression and run the closure | ||
| asynchronously on process `p`. Returns a [`Future`](@ref) to the result. | ||
| Accepts two arguments, `p` and an expression. |
There was a problem hiding this comment.
Perhaps augmenting the signature (rather than describing the signature in the docstring body) would be more consistent with other docstrings?
There was a problem hiding this comment.
I looked at a bunch of other macros in the docs and none of them list their args in the signature. I think that's worth doing but perhaps as a separate PR?
Sacha0
approved these changes
Jun 28, 2017
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.
spawn(command)stubbornly remains, I suppose because it's one of those things that's tightly wound in with the code insrc/?