Base.IOBuffer documentation error

[samoconnor]

The doc for IOBuffer says:

IOBuffer([data,],[readable::Bool=true, writable::Bool=true, [maxsize::Int=typemax(Int)]])

Create an IOBuffer, which may optionally operate on a pre-existing array. If the readable/writable arguments are given, they restrict whether or not the buffer may be read from or written to respectively. By default the buffer is readable but not writable. The last argument optionally specifies a size beyond which the buffer may not be grown.

The part about "by default ... not writeable" is wrong.

julia> io = IOBuffer()
IOBuffer(data=UInt8[...], readable=true, writable=true, seekable=true, append=false, size=0, maxsize=Inf, ptr=1, mark=-1)

julia> io = PipeBuffer()
IOBuffer(data=UInt8[...], readable=true, writable=true, seekable=false, append=true, size=0, maxsize=Inf, ptr=1, mark=-1)

I'm guessing that this may have lead people to use PipeBuffer() instead of IOBuffer() when they do not need seek() and all they are doing is a few writes to a buffer before take!-ing the result.

[samoconnor]

thx @fredrikekre