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

struct documentation should include Sized in the listed auto trait implementations #126421

Open
eggyal opened this issue Jun 13, 2024 · 2 comments
Labels
C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@eggyal
Copy link
Contributor

eggyal commented Jun 13, 2024

This was previously raised in #17606, which was closed when auto-traits were documented in #47833—however, since Sized is not a library-implemented auto-trait but rather a compiler-implemented trait, it was omitted from that solution.

The issue appears to have also been previously raised in #41537 (closed as duplicate of the above) and #75413 (I think erroneously closed as duplicate of #24183).

@rustbot label A-docs C-bug

@rustbot rustbot added needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. A-rustdoc-json Area: Rustdoc JSON backend C-bug Category: This is a bug. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools and removed A-rustdoc-json Area: Rustdoc JSON backend labels Jun 13, 2024
@eggyal eggyal changed the title struct documentation should include Sized or !Sized in the listed auto trait implementations struct documentation should include Sized in the listed auto trait implementations Jun 13, 2024
@eggyal
Copy link
Contributor Author

eggyal commented Jun 13, 2024

@cafce25 has pointed out to me (on StackOverflow) that !Sized is listed for unsized types.

@veera-sivarajan
Copy link
Contributor

@rustbot label -needs-triage +T-docs-rs

@rustbot rustbot added T-docs-rs Relevant to the docs-rs subteam, which will review and decide on the PR/issue. and removed needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. labels Jun 13, 2024
@aDotInTheVoid aDotInTheVoid added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. and removed A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools T-docs-rs Relevant to the docs-rs subteam, which will review and decide on the PR/issue. labels Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

4 participants