Improve std::fs::read_dir docs #145290
Merged
Improve std::fs::read_dir docs #145290
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
Collaborator
rustbot
added
S-waiting-on-review
Member
|
r=me when CI passes. |
tgross35
reviewed
Aug 12, 2025
Member
Contributor
Author
Call out early that the results returned can differ across calls / aren't deterministic. This was already mentioned at the bottom of examples, but I think it's worth calling out early, since this caused at least one person (me!) great confusion. [ Added a comma to the docs, reflowed commit message - Trevor ]
tgross35
approved these changes
Aug 27, 2025
Contributor
|
It's nice to keep good grammar in user-facing docs, but this isn't worth the back-and-forth so I just added the comma and pushed the branch. Thanks for the improvement! @bors r+ rollup |
Collaborator
bors
added
S-waiting-on-bors
Contributor
|
Forgot Josh's r=me above @bors r=joshtriplett,tgross35 |
This comment was marked as off-topic.
This comment was marked as off-topic.
Collaborator
bors
added a commit
that referenced
this pull request
Aug 27, 2025
Rollup of 6 pull requests Successful merges: - #142215 (Use -Zmir-opt-level=0 in tests for MIR building) - #143341 (Mention that casting to *const () is a way to roundtrip with from_raw_parts) - #145078 (Fix wrong cache line size of riscv64) - #145290 (Improve std::fs::read_dir docs) - #145335 (Move WTF-8 code from std into core and alloc) - #145904 (Move `riscv64-gc-unknown-linux-musl` from Tier 2 with Host tools to Tier 2) r? `@ghost` `@rustbot` modify labels: rollup
Contributor
Author
Thanks! |
rust-timer
added a commit
that referenced
this pull request
Aug 27, 2025
Rollup merge of #145290 - ntc2:patch-1, r=joshtriplett,tgross35 Improve std::fs::read_dir docs Call out early that the results returned can differ across calls / aren't deterministic. This was already mentioned at the bottom of examples, but I think it's worth calling out early, since this caused at least one person (me!) great confusion.
github-actions bot
pushed a commit
to model-checking/verify-rust-std
that referenced
this pull request
Sep 9, 2025
Improve std::fs::read_dir docs Call out early that the results returned can differ across calls / aren't deterministic. This was already mentioned at the bottom of examples, but I think it's worth calling out early, since this caused at least one person (me!) great confusion.
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.
Call out early that the results returned can differ across calls / aren't deterministic. This was already mentioned at the bottom of examples, but I think it's worth calling out early, since this caused at least one person (me!) great confusion.