Skip to content

Stop hiding type declarations in docs #49764

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
Diggsey opened this issue Apr 7, 2018 · 3 comments
Closed

Stop hiding type declarations in docs #49764

Diggsey opened this issue Apr 7, 2018 · 3 comments

Comments

@Diggsey
Copy link
Contributor

Diggsey commented Apr 7, 2018

This recent change: 73b97c7 means that in the latest documentation all of the type declarations are collapsed by default.

Personally, I find this incredibly irritating - this is the API reference, the type declaration is one of the most important pieces of information on the page, and in most cases it is not even large enough that collapsing it saves much space.

Example: https://doc.rust-lang.org/nightly/std/borrow/trait.Borrow.html

@GuillaumeGomez
Copy link
Member

I added a PR to allow you to change some behaviors. Also, please recall that your opinion is yours only, I made this change because people were complaining about the fact that it was not hidden by default, not because I just felt like it.

@Diggsey
Copy link
Contributor Author

Diggsey commented Apr 17, 2018

@GuillaumeGomez I realise that, but there's also no process for these kinds of changes, and so no way to object to them before they occur.

For every person who complained about them not being hidden there may well have been ten people who were very happy that it was visible. Based on the admittedly small sample size here it looks like 7:1 against making this change in the first place. In the absence of overwhelming opinion one way or another the defaults should be left alone because consistency is more important!

@GuillaumeGomez
Copy link
Member

That's why I added the settings. Like that, if more debates like this come up about a feature, we'll just add a setting for it and people will do whatever they want with it.

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

2 participants