Skip to content
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

Improve Read::read_exact documentation #74486

Merged
merged 3 commits into from
Jul 20, 2020

Conversation

poliorcetics
Copy link
Contributor

Fixes #72186.

For now I simply added a link to Read::read and held off changing the text in Read::read_exact. I can do it if it is deemed necessary.

@rustbot modify labels: C-enhancement, T-libs

@rustbot rustbot added C-enhancement Category: An issue proposing an enhancement or a PR with one. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. labels Jul 18, 2020
@rust-highfive
Copy link
Collaborator

r? @Mark-Simulacrum

(rust_highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 18, 2020
src/libstd/io/mod.rs Outdated Show resolved Hide resolved
@Mark-Simulacrum
Copy link
Member

r=me with @jyn514's nit fixed

@poliorcetics
Copy link
Contributor Author

@Mark-Simulacrum Done, I checked it locally to ensure the pointed method stayed the same, CI should confirm the whole thing compiles too :)

@jyn514
Copy link
Member

jyn514 commented Jul 19, 2020

@bors r=Mark-Simulacrum rollup=always

@bors
Copy link
Contributor

bors commented Jul 19, 2020

📌 Commit e88220f has been approved by Mark-Simulacrum

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 19, 2020
bors added a commit to rust-lang-ci/rust that referenced this pull request Jul 19, 2020
…arth

Rollup of 4 pull requests

Successful merges:

 - rust-lang#74333 (Deny unsafe operations in unsafe functions in libstd/alloc.rs)
 - rust-lang#74356 (Remove combine function)
 - rust-lang#74419 (Add a thumbv4t-none-eabi target)
 - rust-lang#74485 (More intra-doc links, add explicit exception list to linkchecker)

Failed merges:

 - rust-lang#74486 (Improve Read::read_exact documentation)

r? @ghost
@bors
Copy link
Contributor

bors commented Jul 19, 2020

☔ The latest upstream changes (presumably #74518) made this pull request unmergeable. Please resolve the merge conflicts.

@bors bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Jul 19, 2020
@jyn514
Copy link
Member

jyn514 commented Jul 19, 2020

@bors r=Mark-Simulacrum rollup=always

@bors
Copy link
Contributor

bors commented Jul 19, 2020

📌 Commit 471dd52 has been approved by Mark-Simulacrum

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jul 19, 2020
bors added a commit to rust-lang-ci/rust that referenced this pull request Jul 20, 2020
…arth

Rollup of 9 pull requests

Successful merges:

 - rust-lang#73618 (Documentation for the false keyword)
 - rust-lang#74486 (Improve Read::read_exact documentation)
 - rust-lang#74514 (Do not clobber RUSTDOCFLAGS)
 - rust-lang#74516 (do not try fetching the ancestors of errored trait impls)
 - rust-lang#74520 (include backtrace folder in rust-src component)
 - rust-lang#74523 (Improve documentation for `core::fmt` internals)
 - rust-lang#74527 (Add myself to toolstate change notifications for rustfmt)
 - rust-lang#74534 (Only skip impls of foreign unstable traits)
 - rust-lang#74536 (fix documentation surrounding the `in` and `for` keywords)

Failed merges:

r? @ghost
@bors bors merged commit 03a4727 into rust-lang:master Jul 20, 2020
@poliorcetics poliorcetics deleted the read-exact-doc-point-to-read branch July 20, 2020 06:30
@cuviper cuviper added this to the 1.47.0 milestone May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Read::read_exact docs unnecessarily scare off users
7 participants