added documentation for read command methods (#28748)

* added documentation for read command methods * fixed docs (cherry picked from commit f6c48eb)
JuliaLang · Sep 8, 2018 · 2747c9c · 2747c9c
1 parent 79a7efd
commit 2747c9c
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/base/process.jl b/base/process.jl
@@ -625,13 +625,23 @@ function open(f::Function, cmds::AbstractCmd, args...)
     return ret
 end
 
+"""
+    read(command::Cmd)
+
+Run `command` and return the resulting output as an array of bytes.
+"""
 function read(cmd::AbstractCmd)
     procs = open(cmd, "r", devnull)
     bytes = read(procs.out)
     success(procs) || pipeline_error(procs)
     return bytes
 end
 
+"""
+    read(command::Cmd, String)
+
+Run `command` and return the resulting output as a `String`.
+"""
 read(cmd::AbstractCmd, ::Type{String}) = String(read(cmd))
 
 """