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

rustdoc: Make expand all / collapse all ephemeral #84318

Closed
jsha opened this issue Apr 18, 2021 · 1 comment · Fixed by #84325
Closed

rustdoc: Make expand all / collapse all ephemeral #84318

jsha opened this issue Apr 18, 2021 · 1 comment · Fixed by #84325
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@jsha
Copy link
Contributor

jsha commented Apr 18, 2021

Each rustdoc page has a [+] icon in the top right, which can be used to expand all / collapse all docs:

It also has a series of toggles along the left edge, to expand and collapse specific sections:

And a settings page to set which types of things are collapsed and expanded by default:

image

The left-hand toggles are ephemeral - they aren't remembered across page loads. The settings page settings are durable - they are remembered across page loads. Right now the [+] in the upper right is durable. That's surprising, since it looks the same as the non-durable left hand toggles, and isn't visible in the settings page. Also, it can be used via the + / - keyboard shortcuts, where it might not be as clear that someone is triggering a settings change.

I think we should change the [+] in the upper right to be ephemeral. If someone wants to durably hide all docs (or durably show all docs), the settings page settings should accomplish that.

/cc @GuillaumeGomez @jyn514

@jyn514 jyn514 added A-rustdoc-ui Area: Rustdoc UI (generated HTML) T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Apr 18, 2021
@jyn514
Copy link
Member

jyn514 commented Apr 18, 2021

Sure, that seems reasonable. I expected it to be ephemeral already actually 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants