Skip to content

Rustdoc crams struct fields into same line #34235

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

Closed
est31 opened this issue Jun 12, 2016 · 3 comments
Closed

Rustdoc crams struct fields into same line #34235

est31 opened this issue Jun 12, 2016 · 3 comments

Comments

@est31
Copy link
Member

est31 commented Jun 12, 2016

If you look at the rustdoc generated page for structs with public fields, there is a Field section which lists all the fields.

There is no newline separation between the fields. They look crammed up, and reading them is very unergonomic.

See this example: https://doc.rust-lang.org/libc/x86_64-unknown-linux-gnu/libc/struct.Dl_info.html

Note: I don't mean the first section which looks like rust code, but I mean the section below which essentially repeats the fields.

Confirmed to exist at least with Firefox 47.0 and rustdoc 1.11.0-nightly (915b003e3 2016-06-02), as well as whatever rustdoc has been used to generate above doc.

@steveklabnik
Copy link
Member

There's a PR open #34234

@est31
Copy link
Member Author

est31 commented Jun 12, 2016

@steveklabnik regarding your question in #34234 : I've done a nightly "bisect" using rustup override, and the last nightly that worked was 6e00b5556 2016-05-29, the first with the bug was 601eb13dc 2016-05-31.

So there are 46 possible commits which could have introduced the regression.

Also note that the 05-29 version hasn't listed the types of the fields, whereas the 05-31 version does list them. Maybe this is related.

@GuillaumeGomez
Copy link
Member

It has been fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants