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.

Sign up for GitHub

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

Jump to bottom

Multiple rustdoc fixes #48755

Merged
merged 4 commits into from
Mar 10, 2018
Merged

Multiple rustdoc fixes #48755

merged 4 commits into from
Mar 10, 2018

Conversation

GuillaumeGomez
Copy link
Member

@GuillaumeGomez GuillaumeGomez commented Mar 5, 2018 •
edited
Loading

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Mar 5, 2018
QuietMisdreavus
QuietMisdreavus reviewed Mar 5, 2018
View reviewed changes
src/librustdoc/html/static/main.js Outdated
}
if (hasClass(e, 'impl')) {
if (checkIfThereAreMethods(next.childNodes) &&
(hasClass(next, 'docblock') ||
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this the right way to combine these conditions? Won't this also bar regular docblocks (the original ones, with hand-written docs) from getting fold toggles?

@onur
Copy link
Member

onur commented Mar 5, 2018 •
edited
Loading

@GuillaumeGomez I've been wrong, switching position of main.js and search-index.js doesn't fix #48733 I am not sure what is causing this.

@GuillaumeGomez
Copy link
Member Author

So I remove it.

@GuillaumeGomez GuillaumeGomez force-pushed the rustdoc-fixes branch 3 times, most recently from 3e676e5 to c831a4e Compare March 5, 2018 22:37
@onur
Copy link
Member

onur commented Mar 6, 2018

@GuillaumeGomez I just realized, sidebar also doesn't work in macro pages. You can see it here: https://doc.rust-lang.org/nightly/std/macro.assert.html

This PR is also fixing sidebar in macro pages :-)

@QuietMisdreavus
Copy link
Member

This PR has removed the per-method fold-toggle buttons on inherent impl blocks.

image

@QuietMisdreavus
Copy link
Member 

[01:13:02] ---- [rustdoc] rustdoc/fn-sidebar.rs stdout ----
[01:13:02] 	
[01:13:02] error: htmldocck failed!
[01:13:02] status: exit code: 1
[01:13:02] command: "/usr/bin/python2.7" "/checkout/src/etc/htmldocck.py" "/checkout/obj/build/x86_64-unknown-linux-gnu/test/rustdoc/fn-sidebar.stage2-x86_64-unknown-linux-gnu" "/checkout/src/test/rustdoc/fn-sidebar.rs"
[01:13:02] stdout:
[01:13:02] ------------------------------------------
[01:13:02] 
[01:13:02] ------------------------------------------
[01:13:02] stderr:
[01:13:02] ------------------------------------------
[01:13:02] 17: @has check failed
[01:13:02] 	File does not exist 'foo/constant.bar.html'
[01:13:02] 	// @has foo/constant.bar.html
[01:13:02] 18: @has check failed
[01:13:02] 	File does not exist 'foo/constant.bar.html'
[01:13:02] 	// @has - '//*[@class="sidebar-elems"]' ''
[01:13:02] 
[01:13:02] Encountered 2 errors
[01:13:02] 
[01:13:02] ------------------------------------------
[01:13:02] 
[01:13:02] thread '[rustdoc] rustdoc/fn-sidebar.rs' panicked at 'explicit panic', tools/compiletest/src/runtest.rs:2893:9
[01:13:02] note: Run with `RUST_BACKTRACE=1` for a backtrace.
[01:13:02] 
[01:13:02] 
[01:13:02] failures:
[01:13:02]     [rustdoc] rustdoc/fn-sidebar.rs

@QuietMisdreavus
Copy link
Member

@bors r+ p=1

@bors
Copy link
Contributor

bors commented Mar 9, 2018

📌 Commit 89f4f1b has been approved by QuietMisdreavus

@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 Mar 9, 2018
@Mark-Simulacrum
Copy link
Member

@bors rollup

Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this pull request Mar 9, 2018
@Mark-Simulacrum
Rollup merge of rust-lang#48755 - GuillaumeGomez:rustdoc-fixes, r=Qui…
6970200 
…etMisdreavus

Multiple rustdoc fixes

Fixes rust-lang#48733.

r? @QuietMisdreavus
@Mark-Simulacrum Mark-Simulacrum mentioned this pull request Mar 9, 2018
Closed
@kennytm
Copy link
Member

kennytm commented Mar 10, 2018

@bors rollup-

@bors
Copy link
Contributor

bors commented Mar 10, 2018

⌛ Testing commit 89f4f1b with merge 948e3a3...

bors added a commit that referenced this pull request Mar 10, 2018
@bors
Auto merge of #48755 - GuillaumeGomez:rustdoc-fixes, r=QuietMisdreavus
948e3a3 
Multiple rustdoc fixes

Fixes #48733.

r? @QuietMisdreavus
@bors
Copy link
Contributor

bors commented Mar 10, 2018

☀️ Test successful - status-appveyor, status-travis
Approved by: QuietMisdreavus
Pushing 948e3a3 to master...

@bors bors merged commit 89f4f1b into rust-lang:master Mar 10, 2018
@GuillaumeGomez GuillaumeGomez deleted the rustdoc-fixes branch March 10, 2018 10:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@QuietMisdreavus QuietMisdreavus QuietMisdreavus left review comments

Assignees

@QuietMisdreavus QuietMisdreavus

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@GuillaumeGomez @onur @QuietMisdreavus @bors @Mark-Simulacrum @kennytm @rust-highfive