added documentation for read command methods #28748
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
fredrikekre
added
docs
Merged
KristofferC
reviewed
Aug 19, 2018
base/process.jl
Outdated
| read(command) | ||
|
|
||
| Run a command asynchronously and return an array of bytes from the resulting stream. | ||
| """ |
There was a problem hiding this comment.
I don't think it is true that this runs async?
Also, I think we can specify this as read(command::Cmd) since Cmd is the only exported AbstractCmd? Also, perhaps could write this as, "Run command ..." to show that it is the command argument that is getting run. "The resulting stream" sounds a bit odd, what is the "resulting stream" here? Maybe just call it "output"?
|
The |
KristofferC
pushed a commit
that referenced
this pull request
Aug 20, 2018
* added documentation for read command methods * fixed docs (cherry picked from commit f6c48eb)
staticfloat
pushed a commit
that referenced
this pull request
Aug 24, 2018
* added documentation for read command methods * fixed docs
KristofferC
pushed a commit
that referenced
this pull request
Sep 8, 2018
* added documentation for read command methods * fixed docs (cherry picked from commit f6c48eb)
KristofferC
pushed a commit
that referenced
this pull request
Sep 8, 2018
* added documentation for read command methods * fixed docs (cherry picked from commit f6c48eb)
KristofferC
pushed a commit
that referenced
this pull request
Feb 11, 2019
* added documentation for read command methods * fixed docs (cherry picked from commit f6c48eb)
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.
Added documentation for the
read(::Cmd)andread(::Cmd, ::Type{String})methods.I'm only vaguely familiar with the correct terminology here, so if you have suggestions of how to improve these, please make them.