Skip to content

Commit 5f601c2

Browse files
committed
Add @doc to ensure doc for readstring/readall is used
JuliaLang/julia#14962
1 parent 475824b commit 5f601c2

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/StringEncodings.jl

+4-4
Original file line numberDiff line numberDiff line change
@@ -288,19 +288,19 @@ end
288288

289289
## Convenience I/O functions
290290
if isdefined(Base, :readstring)
291-
"""
291+
@doc """
292292
readstring(stream or filename, enc::ASCIIString)
293293
294294
Read the entire contents of an I/O stream or a file in encoding `enc` as a string.
295-
"""
295+
""" ->
296296
Base.readstring(s::IO, enc::ASCIIString) = readstring(StringDecoder(s, enc))
297297
Base.readstring(filename::AbstractString, enc::ASCIIString) = open(io->readstring(io, enc), filename)
298298
else # Compatibility with Julia 0.4
299-
"""
299+
@doc """
300300
readall(stream or filename, enc::ASCIIString)
301301
302302
Read the entire contents of an I/O stream or a file in encoding `enc` as a string.
303-
"""
303+
""" ->
304304
Base.readall(s::IO, enc::ASCIIString) = readall(StringDecoder(s, enc))
305305
Base.readall(filename::AbstractString, enc::ASCIIString) = open(io->readall(io, enc), filename)
306306
end

0 commit comments

Comments
 (0)