Skip to content

rustdoc: run rustfmt on type definitions #36654

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Closed
fitzgen opened this issue Sep 22, 2016 · 2 comments
Closed

rustdoc: run rustfmt on type definitions #36654

fitzgen opened this issue Sep 22, 2016 · 2 comments

Comments

@fitzgen
Copy link
Member

fitzgen commented Sep 22, 2016

When we have a lot of generic parameters and where clauses, it becomes unreadable in rustdoc pretty quickly.

For example:

screen shot 2016-09-22 at 1 20 04 pm

@hanna-kruppe
Copy link
Contributor

The two PRs backlinked above made me think that perhaps we should rustfmt all code-like snippets included in rustdoc's output. I am not 100% sure, since the snippets in API docs aren't always like real code and don't always serve the same function. But since it's generally supposed to look like Rust code, I guess it's reasonable to apply the same style to it as to real code.

@Mark-Simulacrum
Copy link
Member

Today this looks much better. I think this is effectively "fixed".

image

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

No branches or pull requests

3 participants