Add docstring for read with default nb

JuliaLang · Aug 3, 2016 · 1307ea2 · 1307ea2
1 parent f1cf6d9
commit 1307ea2
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/base/io.jl b/base/io.jl
@@ -342,7 +342,11 @@ function readbytes!(s::IO, b::AbstractArray{UInt8}, nb=length(b))
     return nr
 end
 
-# read up to nb bytes from s, returning a Vector{UInt8} of bytes read.
+"""
+    read(s::IO, nb=typemax(Int))
+
+Read at most `nb` bytes from `s`, returning a `Vector{UInt8}` of the bytes read.
+"""
 function read(s::IO, nb=typemax(Int))
     # Let readbytes! grow the array progressively by default
     # instead of taking of risk of over-allocating

diff --git a/doc/stdlib/io-network.rst b/doc/stdlib/io-network.rst
@@ -168,6 +168,12 @@ General I/O
 
    See ``read`` for a description of the ``all`` option.
 
+.. function:: read(s::IO, nb=typemax(Int))
+
+   .. Docstring generated from Julia source
+
+   Read at most ``nb`` bytes from ``s``\ , returning a ``Vector{UInt8}`` of the bytes read.
+
 .. function:: read(s::IOStream, nb::Integer; all=true)
 
    .. Docstring generated from Julia source