overhauled escape_string's doc and added missing mapping #24539
Conversation
…ing(str, esc) which was missing
kshyatt
added
docs
|
Something else I should do here, or is it just that no one has found the time to review this PR yet? |
Likely the latter. |
base/strings/io.jl
Outdated
| See also [`unescape_string`](@ref). | ||
| The reverse is [`unescape_string`](@ref). | ||
|
|
||
| escape_string(io, str::AbstractString[, esc::AbstractString]) -> Void |
There was a problem hiding this comment.
Typically we list both signatures at the top together, or split into two separate docstrings.
There was a problem hiding this comment.
I prefer the latter. Changed it accordingly.
|
Check errors seem to be unrelated? |
base/strings/io.jl
Outdated
| end | ||
| end) | ||
| end | ||
| d, state = nex |
|
Part of a function is chopped off in the end of the file. Also, it would be nice to have test that checks the different type combinations and the return type. |
|
I don't know how that happend... I'll add some tests later today. |
test/strings/io.jl
Outdated
| buf = IOBuffer() | ||
| print(buf, join(s22021, "\n")) | ||
| @test isvalid(String, take!(buf)) | ||
| end |
There was a problem hiding this comment.
Oh, I think I know why this happened - sync problem while working remotely.
|
Tests added. |
|
IMHO this should be good to go. |
| """ | ||
| function escape_string(io, s::AbstractString, esc::AbstractString) | ||
| escape_string(s::AbstractString, esc::AbstractString) = sprint(endof(s), escape_string, s, esc) | ||
| escape_string(s::AbstractString) = sprint(endof(s), escape_string, s, "\"") |
There was a problem hiding this comment.
This seems to be the wrong default set of esc characters:
julia> sprint(io->escape_string(io, "\""))
"\""
julia> escape_string("\"")
"\\\""
See #22286.