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.

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

rustdoc: don't mark Box<T> as Iterator, Read, etc #103432

Merged
merged 1 commit into from
Oct 27, 2022
Merged

rustdoc: don't mark Box<T> as Iterator, Read, etc #103432

merged 1 commit into from
Oct 27, 2022

Conversation

jsha
Copy link
Contributor

@jsha jsha commented Oct 23, 2022

Because Box has pass-through implementations, rustdoc was giving it the "Notable Traits" treatment for Iterator, Read, Write, and Future, even when the type of T was unspecified.

Pin had the same problem, but just for Future.

Fixes #100320

@jsha jsha added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Oct 23, 2022
@rust-highfive
Copy link
Collaborator

r? @notriddle

(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 Oct 23, 2022
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@GuillaumeGomez
Copy link
Member

Looks good to me, thanks! Please just add a trailing newline at the end of the test to fix the CI error.

jsha
jsha commented Oct 23, 2022
View reviewed changes
src/librustdoc/html/render/mod.rs Outdated
// as being notably an Iterator (etc), though, so we exempt it. Pin has the same
// issue, with a pass-through impl for Future.
if Some(did) == cx.tcx().lang_items().owned_box() ||
Some(did) == cx.tcx().lang_items().pin_type() {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, it's used just below to find impls.

@jsha jsha force-pushed the box-is-not-notable branch from 28c055c to e05382d Compare October 23, 2022 23:37
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jsha
rustdoc: don't mark Box<T> as Iterator, Read, etc
63d1a72 
Because Box<T> has pass-through implementations, rustdoc was giving it the
"Notable Traits" treatment for Iterator, Read, Write, and Future, even when the
type of T was unspecified.

Pin had the same problem, but just for Future.
@jsha jsha force-pushed the box-is-not-notable branch from e05382d to 63d1a72 Compare October 24, 2022 05:14
@jsha
Copy link
Contributor Author

jsha commented Oct 26, 2022

Fixed!

@GuillaumeGomez
Copy link
Member

Thanks!

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Oct 26, 2022

📌 Commit 63d1a72 has been approved by GuillaumeGomez

It is now in the queue for this repository.

@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 Oct 26, 2022
compiler-errors added a commit to compiler-errors/rust that referenced this pull request Oct 26, 2022
@compiler-errors
Rollup merge of rust-lang#103432 - jsha:box-is-not-notable, r=Guillau…
978597f 
…meGomez

rustdoc: don't mark Box<T> as Iterator, Read, etc

Because Box<T> has pass-through implementations, rustdoc was giving it the "Notable Traits" treatment for Iterator, Read, Write, and Future, even when the type of T was unspecified.

Pin had the same problem, but just for Future.

Fixes rust-lang#100320
@compiler-errors compiler-errors mentioned this pull request Oct 26, 2022
Closed
@JohnTitor JohnTitor mentioned this pull request Oct 26, 2022
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Oct 26, 2022
@bors
Auto merge of rust-lang#103604 - JohnTitor:rollup-q4ns2gh, r=JohnTitor
df57f7b 
Rollup of 10 pull requests

Successful merges:

 - rust-lang#103432 (rustdoc: don't mark Box<T> as Iterator, Read, etc)
 - rust-lang#103526 (More dupe typos again)
 - rust-lang#103537 (rustdoc: combine shared CSS between `.*-line-numbers`)
 - rust-lang#103549 (llvm-16: Don't initialize removed legacy passes)
 - rust-lang#103558 (Update cargo)
 - rust-lang#103567 (ptr::eq: clarify that comparing dyn Trait is fragile)
 - rust-lang#103579 (:arrow_up: rust-analyzer)
 - rust-lang#103580 (Fix typo in docs for `guaranteed_ne`)
 - rust-lang#103596 (thread::set_name: debug-assert that things went well)
 - rust-lang#103598 (rustc_lexer::TokenKind improve docs)

Failed merges:

 - rust-lang#103585 (Migrate source line numbers CSS to CSS variables)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit ec7ffdf into rust-lang:master Oct 27, 2022
@rustbot rustbot added this to the 1.66.0 milestone Oct 27, 2022
Aaron1011 pushed a commit to Aaron1011/rust that referenced this pull request Jan 6, 2023
Rollup merge of rust-lang#103432 - jsha:box-is-not-notable, r=Guillau…
c00a32f 
…meGomez

rustdoc: don't mark Box<T> as Iterator, Read, etc

Because Box<T> has pass-through implementations, rustdoc was giving it the "Notable Traits" treatment for Iterator, Read, Write, and Future, even when the type of T was unspecified.

Pin had the same problem, but just for Future.

Fixes rust-lang#100320
Aaron1011 pushed a commit to Aaron1011/rust that referenced this pull request Jan 6, 2023
@bors
Auto merge of rust-lang#103604 - JohnTitor:rollup-q4ns2gh, r=JohnTitor
1e0b113 
Rollup of 10 pull requests

Successful merges:

 - rust-lang#103432 (rustdoc: don't mark Box<T> as Iterator, Read, etc)
 - rust-lang#103526 (More dupe typos again)
 - rust-lang#103537 (rustdoc: combine shared CSS between `.*-line-numbers`)
 - rust-lang#103549 (llvm-16: Don't initialize removed legacy passes)
 - rust-lang#103558 (Update cargo)
 - rust-lang#103567 (ptr::eq: clarify that comparing dyn Trait is fragile)
 - rust-lang#103579 (:arrow_up: rust-analyzer)
 - rust-lang#103580 (Fix typo in docs for `guaranteed_ne`)
 - rust-lang#103596 (thread::set_name: debug-assert that things went well)
 - rust-lang#103598 (rustc_lexer::TokenKind improve docs)

Failed merges:

 - rust-lang#103585 (Migrate source line numbers CSS to CSS variables)

r? `@ghost`
`@rustbot` modify labels: rollup
pietroalbini added a commit to ferrocene/sphinx-shared-resources that referenced this pull request Mar 22, 2023
@bors-ferrocene @Veykril
@pietroalbini @DropDemBits @bors
Merge #600
3f42cd2 
600: Pull changes from upstream `master` r=kirtchev-adacore a=pietroalbini

* rust-lang/rust#103605
* rust-lang/rust#103604
  * rust-lang/rust#103598
  * rust-lang/rust#103596
  * rust-lang/rust#103580
  * rust-lang/rust#103579
  * rust-lang/rust#103567
  * rust-lang/rust#103558
  * rust-lang/rust#103549
  * rust-lang/rust#103537
  * rust-lang/rust#103526
  * rust-lang/rust#103432
* rust-lang/rust#103571
* rust-lang/rust#103492
* rust-lang/rust#103572
  * rust-lang/rust#103554
  * rust-lang/rust#103546
  * rust-lang/rust#103543
  * rust-lang/rust#103428
  * rust-lang/rust#102706
  * rust-lang/rust#95710
* rust-lang/rust#103284
* rust-lang/rust#103562
  * rust-lang/rust#103542
  * rust-lang/rust#103536
  * rust-lang/rust#103533
  * rust-lang/rust#103520
  * rust-lang/rust#103444
  * rust-lang/rust#103430
  * rust-lang/rust#103416
  * rust-lang/rust#103287
  * rust-lang/rust#103209
  * rust-lang/rust#102951
* rust-lang/rust#103279
* rust-lang/rust#103158



Co-authored-by: Lukas Wirth <[email protected]>
Co-authored-by: Pietro Albini <[email protected]>
Co-authored-by: DropDemBits <[email protected]>
Co-authored-by: bors <[email protected]>
Co-authored-by: Pietro Albini <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@GuillaumeGomez GuillaumeGomez GuillaumeGomez approved these changes

Assignees

@notriddle notriddle

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.66.0
Development

Successfully merging this pull request may close these issues.

rustdoc: notable traits triggers on smart pointers
7 participants
@jsha @rust-highfive @rust-log-analyzer @GuillaumeGomez @bors @notriddle @rustbot