Document that create_dir_all calls mkdir/CreateDirW multiple times
#124520
Conversation
rustbot
added
S-waiting-on-review
|
How do those details help the reader? |
|
It's not a single syscall that makes this function work, but additional logic on top of it. That's interesting for the user of this function. |
|
We don't document all the functions that happen to do more than 1 syscall. So, again, why is that interesting to the user? How does it help them to use it? |
|
It's interesting in that it's non-atomic. In the error case, there might be partial directory structures lying around.
Can you give an example of a function that documents which syscall it corresponds to, but uses it multiple times without documenting it? |
Then the docs should say that, rather then trying to say that through the implementation details.
Eh, most docs aren't even that precise. |
Before I'll try to do that: Are you opposed to also mentioning that it's using multiple calls to |
|
Using a plural is fine. Explaining the traversal order seems unnecessary to me. |
Also mention that there might be leftover directories in the error case.
tbu-
force-pushed
the
pr_create_dir_all_doc
branch
from
f2f4730
to
a0f8ada
Compare
|
@bors r+ rollup |
bors
added
S-waiting-on-bors
…iaskrgr Rollup of 4 pull requests Successful merges: - rust-lang#124520 (Document that `create_dir_all` calls `mkdir`/`CreateDirW` multiple times) - rust-lang#124724 (Prefer lower vtable candidates in select in new solver) - rust-lang#124771 (Don't consider candidates with no failing where clauses when refining obligation causes in new solver) - rust-lang#124808 (Use `super_fold` in `RegionsToStatic` visitor) r? `@ghost` `@rustbot` modify labels: rollup
Rollup merge of rust-lang#124520 - tbu-:pr_create_dir_all_doc, r=Amanieu Document that `create_dir_all` calls `mkdir`/`CreateDirW` multiple times
No description provided.