Reword OpenOptions::{create, create_new} doc. #69284
Merged
Conversation
This file contains hidden or 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
rust-highfive added the S-waiting-on-review 
LeSeulArtichaut approved these changes Feb 19, 2020
| r? @Dylan-DPC |
| @bors r+ rollup |
| 📌 Commit c899dc1 has been approved by |
bors added S-waiting-on-bors Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Feb 19, 2020
…ylan-DPC Reword OpenOptions::{create, create_new} doc. Closes rust-lang#69254. Currently, the doc comment for `fs::OpenOptions::create` doesn't mention its behaviour when opening an existing file, and `fs::OpenOptions::create_new`'s doc comment is worded in a way that doesn't make it clear that it actually _fails_ if the file already exists, not overwrite the existing file with a new one. This PR addresses addresses this by rewording the doc comments to be more explicit. r? @GuillaumeGomez This was referenced Feb 19, 2020
bors added a commit that referenced this pull request Feb 19, 2020
Rollup of 5 pull requests Successful merges: - #68863 (ci: switch macOS builders to 10.15) - #69142 (Add shared script for linkchecking books.) - #69248 (Don't eliminate frame pointers on thumb targets) - #69280 (Remove special case for `simd_shuffle` arg promotion) - #69284 (Reword OpenOptions::{create, create_new} doc.) Failed merges: r? @ghost
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
6 participants
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.
Closes #69254.
Currently, the doc comment for
fs::OpenOptions::createdoesn't mention its behaviour when opening an existing file, andfs::OpenOptions::create_new's doc comment is worded in a way that doesn't make it clear that it actually fails if the file already exists, not overwrite the existing file with a new one.This PR addresses addresses this by rewording the doc comments to be more explicit.
r? @GuillaumeGomez