-
Notifications
You must be signed in to change notification settings - Fork 13k
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
Add precision for create_dir function #55621
Conversation
478351f
to
6c5a52b
Compare
Thanks for the polishing @QuietMisdreavus! Updated. |
Oh hey, looking again, there's a perfectly usable "Errors" section that already exists, right below the note you added! How about adding this to that list instead? - A parent directory does not exist. To create a directory and all its parent directories at the same time, use [`create_dir_all`]. |
Ah sure. The problem is that it looks exactly like the |
"Looking the same as the other docs" is the point. If we have the note somewhere, people will be able to find it. I don't want to have two different sections that describe when a function returns an error; the one you're adding is just redundant. We have a perfectly serviceable documentation standard when describing the situations where a function returns an error, please use it. |
6c5a52b
to
424fecd
Compare
Added it to the error list. |
The other note is still there, but looking at it again, i think it's probably fine to leave it. If it seems redundant to enough other people, we can take it out later. Thanks! @bors r+ rollup |
📌 Commit 424fecd has been approved by |
…isdreavus Add precision for create_dir function Took me a while to find the other equivalent so it seems to be necessary. r? @QuietMisdreavus
Rollup of 11 pull requests Successful merges: - #55490 (resolve: Fix ICE in macro import error recovery) - #55597 (std: Enable usage of `thread_local!` through imports) - #55601 (Fix tracking issue numbers for some unstable features) - #55621 (Add precision for create_dir function) - #55644 (ci: Add Dockerfile for dist-powerpcspe-linux) - #55664 (Make "all possible cases" help message uniform with existing help messages) - #55689 (miri: binary_op_val -> binary_op_imm) - #55694 (Fixes #31076) - #55696 (NLL Diagnostic Review 3: Missing errors for borrows of union fields) - #55700 (Update ui tests with respect to NLL) - #55703 (Update `configure --help` (via configure.py) to reflect decoupling of debug+optimize)
Took me a while to find the other equivalent so it seems to be necessary.
r? @QuietMisdreavus