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

Particially revert #73771 #76529

Closed
wants to merge 3 commits into from
Closed

Conversation

tesuji
Copy link
Contributor

@tesuji tesuji commented Sep 9, 2020

Hopefully this should close #75588.
cc #74534

@rust-highfive
Copy link
Collaborator

r? @Mark-Simulacrum

(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 Sep 9, 2020
@LeSeulArtichaut
Copy link
Contributor

Maybe cc @GuillaumeGomez?

@GuillaumeGomez
Copy link
Member

@rust-lang/rustdoc works too. ;)

@GuillaumeGomez GuillaumeGomez added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Sep 9, 2020
@LeSeulArtichaut
Copy link
Contributor

LeSeulArtichaut commented Sep 9, 2020

(Just wanted to ping you as the reviewer of #73771 😁) Right, there were a bunch of people who commented on that PR

@GuillaumeGomez
Copy link
Member

Absolutely. ;)

@jyn514
Copy link
Member

jyn514 commented Sep 9, 2020

std/primitive.usize.html:940: broken link fragment `#tymethod.from_u64` pointing to `std/primitive.usize.html`
std/primitive.u32.html:942: broken link fragment `#tymethod.from_u64` pointing to `std/primitive.u32.html`
std/primitive.u64.html:927: broken link fragment `#tymethod.from_u64` pointing to `std/primitive.u64.html`
std/primitive.slice.html:1555: broken link - /checkout/obj/build/x86_64-unknown-linux-gnu/std/primitive.slice.html
std/primitive.slice.html:1559: broken link - /checkout/obj/build/x86_64-unknown-linux-gnu/std/primitive.slice.html
std/primitive.slice.html:1575: broken link - /checkout/obj/build/x86_64-unknown-linux-gnu/std/primitive.slice.html
std/primitive.slice.html:1577: broken link - /checkout/obj/build/x86_64-unknown-linux-gnu/std/primitive.slice.html
std/primitive.slice.html:1579: broken link - /checkout/obj/build/x86_64-unknown-linux-gnu/std/primitive.slice.html
thread 'main' panicked at 'found some broken links', src/tools/linkchecker/main.rs:68:9

well that's odd.

@tesuji
Copy link
Contributor Author

tesuji commented Sep 10, 2020

std/primitive.slice.html has broken links because after this PR, it displays Concat trait implementations.
Before that, they are hidden.

std/primitive.u64.html has a broken link for impl ReaderOffset for usize, which was hidden by #73771.

@jyn514
Copy link
Member

jyn514 commented Sep 10, 2020

I don't understand, sorry. What do the broken links have to do with the new implementors being shown? I don't see any links to #tymethod.from_u64 or ::from_u64 in the source code.

@tesuji
Copy link
Contributor Author

tesuji commented Sep 10, 2020

To reproduce the issue, one has to build with --stage 1.

For usize, the "Read more" link is broken: http://0.0.0.0:8000/std/primitive.usize.html#tymethod.from_u64
image

For Concat trait under std/primitive.slice: note the ../../. It is kind of problems that intra-docs link trying to solve.

/// Implementation of [`[T]::concat`](../../std/primitive.slice.html#method.concat)

@jyn514
Copy link
Member

jyn514 commented Sep 10, 2020

Got it, thanks. The broken primitive.slice.html link can't be fixed until #63351 is.

I took a look at #from_u64 - they don't actually have a link there:
image

So it seems like rustdoc itself is generating invalid links 🤦

Since this is intended to be backported to beta, I think we should just whitelist the broken links for now. If you want to try and fix the issues in a follow-up commit that would be great :) but I think only the revert should be backported.

@tesuji tesuji marked this pull request as ready for review September 10, 2020 05:25
@tesuji
Copy link
Contributor Author

tesuji commented Sep 10, 2020

Another candidate: #76571

@Mark-Simulacrum
Copy link
Member

r? @jyn514 -- seems like you have a better handle than I on these things

Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Sep 12, 2020
…n514

Ignore rustc_private items from std docs

By ignoring rustc_private items for non local impl block,
this may fix rust-lang#74672 and fix rust-lang#75588 .

This might suppress rust-lang#76529 if it is simple enough for backport.
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Sep 12, 2020
…n514

Ignore rustc_private items from std docs

By ignoring rustc_private items for non local impl block,
this may fix rust-lang#74672 and fix rust-lang#75588 .

This might suppress rust-lang#76529 if it is simple enough for backport.
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Sep 12, 2020
…n514

Ignore rustc_private items from std docs

By ignoring rustc_private items for non local impl block,
this may fix rust-lang#74672 and fix rust-lang#75588 .

This might suppress rust-lang#76529 if it is simple enough for backport.
bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 14, 2020
Ignore rustc_private items from std docs

By ignoring rustc_private items for non local impl block,
this may fix rust-lang#74672 and fix rust-lang#75588 .

This might suppress rust-lang#76529 if it is simple enough for backport.
@bors
Copy link
Contributor

bors commented Sep 14, 2020

☔ The latest upstream changes (presumably #76571) made this pull request unmergeable. Please resolve the merge conflicts.

Note that reviewers usually do not review pull requests until merge conflicts are resolved! Once you resolve the conflicts, you should change the labels applied by bors to indicate that your PR is ready for review. Post this as a comment to change the labels:

@rustbot modify labels: +S-waiting-on-review -S-waiting-on-author

@jyn514
Copy link
Member

jyn514 commented Sep 14, 2020

I'm going to close this: I think #76571 is a better candidate for backport and we can always re-open it against beta if the rustdoc team decides they don't want to backport 76571.

@jyn514 jyn514 closed this Sep 14, 2020
@tesuji tesuji deleted the revert-73771 branch September 14, 2020 11:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing Implementors for Join and Pattern trait in rustdoc
7 participants