-
Notifications
You must be signed in to change notification settings - Fork 13.2k
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
Comments
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? |
Thanks for this! What about changing the “[+]” element to be clearer about it’s behaviour?
… On 25 Apr 2019, at 06:36, Guillaume Gomez ***@***.***> wrote:
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?
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub, or mute the thread.
|
That's another debate. |
If that is another debate would you prefer to have another issue opened with relation to that matter? |
Yes please! |
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. |
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). |
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:
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:
Thank you!
EDIT: Added missing link.
EDIT 2: Clarify this issue's context and add link.
The text was updated successfully, but these errors were encountered: