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: Show type layout for type aliases #91682

Merged
merged 1 commit into from
Dec 11, 2021
Merged

rustdoc: Show type layout for type aliases #91682

merged 1 commit into from
Dec 11, 2021

Conversation

camelid
Copy link
Member

@camelid camelid commented Dec 9, 2021

Fixes #91265.

At first, you might think, "Why not just click through to the aliased
type?" But, if a type alias instantiates all of the generic parameters
of the aliased type, then it can show layout info even though the
aliased type cannot (because we can't compute layout for generic types).
So, I think it's useful to show layout info for type aliases.

This is a followup of 78d4b453ad2e19d44011b26fc55c949bff5dba3d
(originally part of #83501).

@camelid camelid added A-rustdoc-type-layout Area: `rustdoc --show-type-layout` (nightly-only) T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Dec 9, 2021
@rust-highfive
Copy link
Collaborator

r? @ollie27

(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 Dec 9, 2021
@camelid
Copy link
Member Author

camelid commented Dec 9, 2021

r? @jyn514

@rust-highfive rust-highfive assigned jyn514 and unassigned ollie27 Dec 9, 2021
@camelid
rustdoc: Show type layout for type aliases
e36da67 
At first, you might think, "Why not just click through to the aliased
type?" But, if a type alias instantiates all of the generic parameters
of the aliased type, then it can show layout info even though the
aliased type cannot (because we can't compute layout for generic types).
So, I think it's useful to show layout info for type aliases.

This is a followup of 78d4b453ad2e19d44011b26fc55c949bff5dba3d
(originally part of rust-lang#83501).
jyn514
jyn514 approved these changes Dec 9, 2021
View reviewed changes
Copy link
Member

@jyn514 jyn514 left a comment

Choose a reason for hiding this comment

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

Yeah, this seems reasonable :) not sure it makes sense to show the layout error but we can fix that separately.

@jyn514
Copy link
Member

jyn514 commented Dec 9, 2021

@bors r+

@bors
Copy link
Contributor

bors commented Dec 9, 2021

📌 Commit e36da67 has been approved by jyn514

@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 Dec 9, 2021
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Dec 9, 2021
@matthiaskrgr
Rollup merge of rust-lang#91682 - camelid:alias-layout, r=jyn514
1eac9b7 
rustdoc: Show type layout for type aliases

Fixes rust-lang#91265.

At first, you might think, "Why not just click through to the aliased
type?" But, if a type alias instantiates all of the generic parameters
of the aliased type, then it can show layout info even though the
aliased type cannot (because we can't compute layout for generic types).
So, I think it's useful to show layout info for type aliases.

This is a followup of 78d4b453ad2e19d44011b26fc55c949bff5dba3d
(originally part of rust-lang#83501).
@matthiaskrgr matthiaskrgr mentioned this pull request Dec 9, 2021
Closed
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Dec 10, 2021
@matthiaskrgr
Rollup merge of rust-lang#91682 - camelid:alias-layout, r=jyn514
de3d1cc 
rustdoc: Show type layout for type aliases

Fixes rust-lang#91265.

At first, you might think, "Why not just click through to the aliased
type?" But, if a type alias instantiates all of the generic parameters
of the aliased type, then it can show layout info even though the
aliased type cannot (because we can't compute layout for generic types).
So, I think it's useful to show layout info for type aliases.

This is a followup of 78d4b453ad2e19d44011b26fc55c949bff5dba3d
(originally part of rust-lang#83501).
@matthiaskrgr matthiaskrgr mentioned this pull request Dec 10, 2021
Closed
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Dec 11, 2021
@matthiaskrgr
Rollup merge of rust-lang#91682 - camelid:alias-layout, r=jyn514
74f225b 
rustdoc: Show type layout for type aliases

Fixes rust-lang#91265.

At first, you might think, "Why not just click through to the aliased
type?" But, if a type alias instantiates all of the generic parameters
of the aliased type, then it can show layout info even though the
aliased type cannot (because we can't compute layout for generic types).
So, I think it's useful to show layout info for type aliases.

This is a followup of 78d4b453ad2e19d44011b26fc55c949bff5dba3d
(originally part of rust-lang#83501).
@matthiaskrgr matthiaskrgr mentioned this pull request Dec 11, 2021
Closed
@matthiaskrgr matthiaskrgr mentioned this pull request Dec 11, 2021
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 11, 2021
@bors
Auto merge of rust-lang#91792 - matthiaskrgr:rollup-2epg7jq, r=matthi…
b8dc6aa 
…askrgr

Rollup of 7 pull requests

Successful merges:

 - rust-lang#91617 (Improve the readability of `List<T>`.)
 - rust-lang#91640 (Simplify collection of in-band lifetimes)
 - rust-lang#91682 (rustdoc: Show type layout for type aliases)
 - rust-lang#91711 (Improve `std::iter::zip` example)
 - rust-lang#91717 (Add deprecation warning for --passes)
 - rust-lang#91718 (give more help in the unaligned_references lint)
 - rust-lang#91782 (Correct since attribute for `is_symlink` feature)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 33ebf4d into rust-lang:master Dec 11, 2021
@rustbot rustbot added this to the 1.59.0 milestone Dec 11, 2021
@camelid camelid deleted the alias-layout branch December 11, 2021 20:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jyn514 jyn514 jyn514 approved these changes

Assignees

@jyn514 jyn514

Labels
A-rustdoc-type-layout Area: `rustdoc --show-type-layout` (nightly-only) 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.59.0
Development

Successfully merging this pull request may close these issues.

rustdoc: Show type layout for type aliases
6 participants
@camelid @rust-highfive @jyn514 @bors @ollie27 @rustbot