Fix broken links with --document-private-items in the standard library
#81179
Conversation
This file contains 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
As it was suggested in rust-lang#81037 `SpecFromIter` is not in the scope and therefore (even it should fail), we get a warning when we try do document private intems in `rust/library/alloc/`. This fixes rust-lang#81037 by adding the trait in the scope and also adding an `allow(unused_imports)` flag so that the compiler does not complain, Since the trait is not used per se in the code, it's just needed to have properly documented docs.
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @cramertj (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
tesuji
reviewed
Jan 19, 2021
--document-private-items in the standard library
|
@bors r+ rollup I edited the description to remove 'fixes' because stdarch still gives warnings. |
|
📌 Commit bc6720f has been approved by |
I already made a PR to |
m-ou-se
added a commit
to m-ou-se/rust
that referenced
this pull request
Jan 20, 2021
…n514 Fix broken links with `--document-private-items` in the standard library As it was suggested in rust-lang#81037 `SpecFromIter` is not in the scope and therefore we get a warning when we try to do document private intems in `rust/library/alloc/`. This addresses rust-lang#81037 by adding the trait in the scope as `@jyn514` suggested and also adding an `allow(unused_imports)` flag so that the compiler does not complain, Since the trait is not used per se in the code, it's just needed to have properly documented docs.
m-ou-se
added a commit
to m-ou-se/rust
that referenced
this pull request
Jan 20, 2021
…n514 Fix broken links with `--document-private-items` in the standard library As it was suggested in rust-lang#81037 `SpecFromIter` is not in the scope and therefore we get a warning when we try to do document private intems in `rust/library/alloc/`. This addresses rust-lang#81037 by adding the trait in the scope as ``@jyn514`` suggested and also adding an `allow(unused_imports)` flag so that the compiler does not complain, Since the trait is not used per se in the code, it's just needed to have properly documented docs.
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jan 21, 2021
Rollup of 11 pull requests Successful merges: - rust-lang#79655 (Add Vec visualization to understand capacity) - rust-lang#80172 (Use consistent punctuation for 'Prelude contents' docs) - rust-lang#80429 (Add regression test for mutual recursion in obligation forest) - rust-lang#80601 (Improve grammar in documentation of format strings) - rust-lang#81046 (Improve unknown external crate error) - rust-lang#81178 (Visit only terminators when removing landing pads) - rust-lang#81179 (Fix broken links with `--document-private-items` in the standard library) - rust-lang#81184 (Remove unnecessary `after_run` function) - rust-lang#81185 (Fix ICE in mir when evaluating SizeOf on unsized type) - rust-lang#81187 (Fix typo in counters.rs) - rust-lang#81219 (Document security implications of std::env::temp_dir) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
As it was suggested in #81037
SpecFromIteris notin the scope and therefore we get a warning when we try to
do document private intems in
rust/library/alloc/.This addresses #81037 by adding the trait in the scope as @jyn514
suggested and also adding an
allow(unused_imports)flag so thatthe compiler does not complain, Since the trait is not used
per se in the code, it's just needed to have properly documented
docs.