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

Default docs.rs setting is harder to navigate #60215

Closed
Firstyear opened this issue Apr 23, 2019 · 7 comments
Closed

Default docs.rs setting is harder to navigate #60215

Firstyear opened this issue Apr 23, 2019 · 7 comments
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@Firstyear
Copy link
Contributor

Firstyear commented Apr 23, 2019

Docs.rs (after this change https://github.com/rust-lang/rust/pull/49954/files ) now collapses function definitions by default. This means that the default view a consumer of documentation now sees:

Screen Shot 2019-04-24 at 07 56 31

The small "[+]" as a symbol is really hard to notice, and so people can easily overlook that it's there - I know I would not have thought to click it unless I was told to, and I now have people asking if my libraries are documented at all (they are), but they don't see it because of the default collapse.

There are a few changes I would suggest here to make this more user-interaction and human friendly:

  • The function definitions should be expanded by default and the setting should be per-user to collapse (This is this issue here).
  • The item should be "[+ expand]" or "[- collapse]" - text helps people to understand the way to use an item, where currently you could over look the "[+]" as a list marker instead. Docs rs "[+]" ui element does not afford usage clearly #60255
  • The settings in the settings menu don't seem to "persist" so, that's a unique problem of itself. (Already open issue)

Thank you!

EDIT: Added missing link.
EDIT 2: Clarify this issue's context and add link.

@jonas-schievink jonas-schievink added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Apr 23, 2019
@GuillaumeGomez
Copy link
Member

If I get approval from @rust-lang/rustdoc, I'll change the default values so the functions aren't collapsed by default.

So what do you think about it @rust-lang/rustdoc?

@Firstyear
Copy link
Contributor Author

Firstyear commented Apr 25, 2019 via email

@GuillaumeGomez
Copy link
Member

That's another debate.

@Firstyear
Copy link
Contributor Author

If that is another debate would you prefer to have another issue opened with relation to that matter?

@GuillaumeGomez
Copy link
Member

Yes please!

@QuietMisdreavus
Copy link
Member

Oh, i didn't realize our default was to fold up the function docs! Yes, we should leave those unfolded if there's no overriding setting.

@Mark-Simulacrum
Copy link
Member

We appear to no longer fold functions by default (at least when looking at a random rustdoc page in private browsing to hopefully ignore any locally-stored preferences of mine).

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

5 participants