Skip to content

Confusing sentence about errors in fs::read #114432

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.

Sign up for GitHub

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

Jump to bottom
Closed
Dexus0 opened this issue Aug 3, 2023 · 0 comments · Fixed by #114448
Closed

Confusing sentence about errors in fs::read #114432

Dexus0 opened this issue Aug 3, 2023 · 0 comments · Fixed by #114448
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools Libs-Small Libs issues that are considered "small" or self-contained T-libs Relevant to the library team, which will review and decide on the PR/issue.

Comments

@Dexus0
Copy link

Dexus0 commented Aug 3, 2023 •
edited
Loading

Location

fs::read's errors section

Summary

It holds this hard to follow sentence:

"It will also return an error if it encounters while reading an error of a kind other than [io::ErrorKind::Interrupted]."
fs::read
@Dexus0 Dexus0 added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Aug 3, 2023
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Aug 3, 2023
@saethlin saethlin added T-libs Relevant to the library team, which will review and decide on the PR/issue. Libs-Small Libs issues that are considered "small" or self-contained and removed needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. labels Aug 3, 2023
@SteveLauC SteveLauC mentioned this issue Aug 4, 2023
Merged
@bors bors closed this as completed in dc348db Sep 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools Libs-Small Libs issues that are considered "small" or self-contained T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: improve std::fs::read doc SteveLauC/rustlang
3 participants
@saethlin @rustbot @Dexus0