-
Notifications
You must be signed in to change notification settings - Fork 13.3k
doc: miscellaneous OpenOptions:append improvements #31093
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
(rust_highfive has picked a reviewer for you, use r? to override) |
@@ -436,19 +436,19 @@ impl OpenOptions { | |||
/// Note that setting `.write(true).append(true)` has the same effect as | |||
/// setting only `.append(true)`. | |||
/// | |||
/// For most filesystems the operating system guarantees all writes are | |||
/// For most filesystems, the operating system guarantees all writes to be |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This actually sounds worse to my ear, is there any precedence anywhere?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
An alternative is "the operating system guarantees that all writes are atomic".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
I like it all except that one thing. |
/// can be done by concatenating strings before passing them to `write()`, | ||
/// or using a buffered writer (with a more than adequately sized buffer) | ||
/// or using a buffered writer (with a more than adequately-sized buffer), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't believe a -
is needed between an adverb and the adjective it modifies ("adequately-sized" doesn't look "correct" to me, in other words). However, this kind of "multi-word adjective" -- "more than adequately sized" -- always feels a little awkward and informal to me in any case. Perhaps "with a buffer of sufficient size" or "with a sufficiently large buffer". (Also, I have no idea what a "more than adequately sized buffer" even is supposed to mean -- surely "adequate" size would be enough, since that is sort of the definition of adequate?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good points
review comments addresed |
@bors: r+ rollup thank you! |
📌 Commit 012d68a has been approved by |
No description provided.