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

Fix default value for setting "Auto-hide item methods' documentation" #60346

Merged
merged 1 commit into from
Apr 28, 2019
Merged

Fix default value for setting "Auto-hide item methods' documentation" #60346

merged 1 commit into from
Apr 28, 2019

Conversation

dima74
Copy link
Contributor

@dima74 dima74 commented Apr 28, 2019

If I open any documentation page in incognito mode (for example for Option enum), then methods will be collapsed, though on the settings page there will be displayed that "Auto-hide item methods' documentation" option is disabled.

If I understand correctly, property "Auto-hide item methods' documentation" should be disabled by default, so correct check would be property === "true". This is consistent with other options:

Options which are enabled by default are compared to "false"

("item-declarations", "Auto-hide item declarations.", true),
("item-attributes", "Auto-hide item attributes.", true),
("trait-implementations", "Auto-hide trait implementations documentation",
true),

var showItemDeclarations = getCurrentValue("rustdoc-item-declarations") === "false";

if (getCurrentValue("rustdoc-item-attributes") !== "false") {

} else if (getCurrentValue("rustdoc-trait-implementations") !== "false") {

Options which are disabled by default are compared to "true"

("go-to-only-result", "Directly go to item in search if there is only one result",
false),
("line-numbers", "Show line numbers on code examples", false),

getCurrentValue("rustdoc-go-to-only-result") === "true") {

if (getCurrentValue("rustdoc-line-numbers") === "true") {

@rust-highfive
Copy link
Collaborator

Some changes occurred in HTML/CSS.

cc @GuillaumeGomez

@rust-highfive
Copy link
Collaborator

r? @QuietMisdreavus

(rust_highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Apr 28, 2019
@GuillaumeGomez
Copy link
Member

Thanks!

@bors: r+ rollup

@bors
Copy link
Contributor

bors commented Apr 28, 2019

📌 Commit b6cfcd3 has been approved by GuillaumeGomez

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 28, 2019
@bors
Copy link
Contributor

bors commented Apr 28, 2019

⌛ Testing commit b6cfcd3 with merge 3418d2f...

bors added a commit that referenced this pull request Apr 28, 2019
Fix default value for setting "Auto-hide item methods' documentation"

If I open any documentation page in incognito mode (for example [for `Option` enum](https://doc.rust-lang.org/nightly/std/option/enum.Option.html)), then methods will be collapsed, though [on the settings page](https://doc.rust-lang.org/nightly/settings.html) there will be displayed that "Auto-hide item methods' documentation" option is disabled.

If I understand correctly, property "Auto-hide item methods' documentation" [should be disabled by default](https://github.com/rust-lang/rust/blob/938d4ffe16c4430e1dcede570b06227114cb73d5/src/librustdoc/html/render.rs#L1969), so correct check would be `property === "true"`. This is consistent with other options:

Options which are enabled by default are compared to `"false"`

https://github.com/rust-lang/rust/blob/938d4ffe16c4430e1dcede570b06227114cb73d5/src/librustdoc/html/render.rs#L1965-L1968

https://github.com/rust-lang/rust/blob/938d4ffe16c4430e1dcede570b06227114cb73d5/src/librustdoc/html/static/main.js#L2238
https://github.com/rust-lang/rust/blob/938d4ffe16c4430e1dcede570b06227114cb73d5/src/librustdoc/html/static/main.js#L2321
https://github.com/rust-lang/rust/blob/938d4ffe16c4430e1dcede570b06227114cb73d5/src/librustdoc/html/static/main.js#L2070

Options which are disabled by default are compared to `"true"`

https://github.com/rust-lang/rust/blob/938d4ffe16c4430e1dcede570b06227114cb73d5/src/librustdoc/html/render.rs#L1970-L1972

https://github.com/rust-lang/rust/blob/938d4ffe16c4430e1dcede570b06227114cb73d5/src/librustdoc/html/static/main.js#L1389
https://github.com/rust-lang/rust/blob/938d4ffe16c4430e1dcede570b06227114cb73d5/src/librustdoc/html/static/main.js#L2334
@bors
Copy link
Contributor

bors commented Apr 28, 2019

☀️ Test successful - checks-travis, status-appveyor
Approved by: GuillaumeGomez
Pushing 3418d2f to master...

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label Apr 28, 2019
@bors bors merged commit b6cfcd3 into rust-lang:master Apr 28, 2019
@dima74 dima74 deleted the patch-1 branch April 28, 2019 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merged-by-bors This PR was explicitly merged by bors. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants