extend write docstring #30677
Merged
extend write docstring #30677
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
base/io.jl
Outdated
| @@ -176,6 +176,19 @@ julia> write(io, "Sometimes those members") + write(io, " write documentation.") | |||
| julia> String(take!(io)) | |||
| "Sometimes those members write documentation." | |||
| ``` | |||
| Note that in general the value needs to be wrapped in a `Ref`, but for several basic types this can be skipped as above. | |||
There was a problem hiding this comment.
I think this makes it sound like Ref is needed more often than it really is. In practice, most/all types with a sensible binary representation have direct write methods. In fact I'm not even sure this use of Ref is intended; it's buggy and will sometimes write references as their address.
Maybe I'd say "User-defined plain-data types without write methods can be written when wrapped in a Ref".
There was a problem hiding this comment.
Okay I changed it. I think there should be a default way to write bitstypes in Base. Whether it is via write(io, Ref(obj)) or another function I don't have a strong opinion about.
kshyatt
added
domain:docs
|
Can somebody rerun appveyor? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See also: https://discourse.julialang.org/t/write-bytes-of-object-to-io/19444/6