Skip to content

rustdoc: display field types together with names in detailed docs#33377

Closed
birkenfeld wants to merge 1 commit into
rust-lang:masterfrom
birkenfeld:issue-32024
Closed

rustdoc: display field types together with names in detailed docs#33377
birkenfeld wants to merge 1 commit into
rust-lang:masterfrom
birkenfeld:issue-32024

Conversation

@birkenfeld

Copy link
Copy Markdown
Contributor

Is this desirable? The problem I can see is that the type names might get quite long.

Fixes: #32024

@rust-highfive

Copy link
Copy Markdown
Contributor

r? @cmr

(rust_highfive has picked a reviewer for you, use r? to override)

@emberian

emberian commented May 3, 2016

Copy link
Copy Markdown
Contributor

I think I'm in favor.

@steveklabnik

Copy link
Copy Markdown
Contributor

Can you show a screenshot of what this looks like?

@birkenfeld

Copy link
Copy Markdown
Contributor Author

Sure:
shot1
shot2

@GuillaumeGomez

Copy link
Copy Markdown
Member

Nice but I'm afraid it's a bit too loaded. Hard choice...

@emberian

emberian commented May 4, 2016

Copy link
Copy Markdown
Contributor

To render this nicely, I think the field name and type should be on its own line, with the documentation for it following indented a bit.

@emberian

emberian commented May 4, 2016

Copy link
Copy Markdown
Contributor

(And I think the Fields header and section shouldn't be intended so much)

@birkenfeld

Copy link
Copy Markdown
Contributor Author

If no one beats me to it, I'll change this to implement @cmr's suggestions.

@birkenfeld

Copy link
Copy Markdown
Contributor Author

New try! Shots:

shot1
shot2

@GuillaumeGomez

Copy link
Copy Markdown
Member

I really don't like this design. :-/

Maybe with the "[-]" thing, it would work better at first. But I don't know how we could display the field's information nicely...

@TyOverby

Copy link
Copy Markdown
Contributor

Big 👍 for me! I always felt dumb having to scroll up to check field types.

@bors

bors commented May 30, 2016

Copy link
Copy Markdown
Collaborator

☔ The latest upstream changes (presumably #33965) made this pull request unmergeable. Please resolve the merge conflicts.

@alexcrichton

Copy link
Copy Markdown
Member

Closing due to inactivity, but feel free to reopen with a rebase!

@birkenfeld birkenfeld deleted the issue-32024 branch August 7, 2016 07:07
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

Successfully merging this pull request may close these issues.

8 participants