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: Named fields should have their types displayed next to their descriptions #32024

Closed
crumblingstatue opened this issue Mar 3, 2016 · 2 comments
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@crumblingstatue
Copy link
Contributor

Right now, the types of (struct / enum variant) fields are only displayed in the "code box" at the top:

But the "code box" is not the usual place to go for documentation, as it is lacking the descriptions written by the author.

The actual descriptions are located further down. How much further depends on how many fields the struct/enum contains, but can be far enough that the "code box" is not visible anymore, so you can't see the types of the fields.

This is inconvenient. One does not want to jump back and forth between the "code box" and the descriptions to be able to know both the type and purpose of the field.

Furthermore, direct links to struct enum variants drop you off at the description site, so you only get the description, and have to scroll up if you also want to get the type information.

@alexcrichton alexcrichton added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Mar 3, 2016
birkenfeld added a commit to birkenfeld/rust that referenced this issue May 9, 2016
@birkenfeld
Copy link
Contributor

This was implemented by #33867 and can be closed.

@crumblingstatue
Copy link
Contributor Author

Neat!

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