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

rustdoc: Bad rendering of enums with named fields #54758

Closed
RalfJung opened this issue Oct 2, 2018 · 0 comments
Closed

rustdoc: Bad rendering of enums with named fields #54758

RalfJung opened this issue Oct 2, 2018 · 0 comments
Assignees
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@RalfJung
Copy link
Member

RalfJung commented Oct 2, 2018

Consider the documentation at https://doc.rust-lang.org/nightly/nightly-rustc/rustc/ty/layout/enum.Abi.html. After expanding the fields, it looks like

screenshot from 2018-10-02 19-55-03

To me this looks like an enum with 4 variants. The way things are indented, I did not even realize that there is a fifth variant, Aggregate. I don't mind so much that the tables showing the enum variant fields are not very pretty, but the way they are flushed to the left makes the entire thing really hard to read.

@Havvy Havvy added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Oct 2, 2018
@GuillaumeGomez GuillaumeGomez self-assigned this Oct 2, 2018
kennytm added a commit to kennytm/rust that referenced this issue Oct 28, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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

3 participants