doc: fix sync/async documentation for file I/O #16491
Closed
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
| @@ -4057,7 +4057,8 @@ abs2 | |||
| write(filename::AbstractString, x) | |||
|
|
|||
| Write the canonical binary representation of a value to the given I/O stream or file. | |||
| Returns the number of bytes written into the stream. | |||
| Returns the number of bytes written into the stream. *`write(::IOStream, ...)` is a synchronous operation and will block at the process level.* | |||
There was a problem hiding this comment.
These should be line wrapped, and probably migrated inline while you're adjusting them.
There was a problem hiding this comment.
Also, it's a bit weird to say that only the ::IOStream method is blocking, since this also applies to the ::AbstractString one. Why not just say "This is a ...". Same below.
ihnorton
force-pushed
the
iodoc-correction
branch
from
3a525c7 to
22bceda
Compare
|
This would still be nice to have if you want to update the syntax and address comments, @ihnorton. Feel free to reopen w/ changes :) |
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.
cross-ref #13450