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

Broken links of &mut self in Deref sections #74083

Closed
tesuji opened this issue Jul 6, 2020 · 3 comments
Closed

Broken links of &mut self in Deref sections #74083

tesuji opened this issue Jul 6, 2020 · 3 comments
Labels
C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@tesuji
Copy link
Contributor

tesuji commented Jul 6, 2020

In https://doc.rust-lang.org/nightly/std/io/struct.IoSlice.html#method.as_ptr, the link to as_mut_ptr is broken.
Even though there is as_mut_ptr item in the sidebar.

This maybe one reason make #32129 happens.
@JohnTitor JohnTitor added C-bug Category: This is a bug. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Jul 6, 2020
@tesuji
Copy link
Contributor Author

tesuji commented Jul 6, 2020

Maybe if there are no DerefMut<Target = U> for type T:

  • hide &mut self methods on sidebar
  • Any refs to &mut self in U shouldn't be fragment links only.

@nbdd0121 nbdd0121 mentioned this issue Jul 6, 2020
Merged
@nbdd0121
Copy link
Contributor

nbdd0121 commented Jul 7, 2020

What would be sensible way to deal with &mut self ref in U though? It doesn't make much sense to point to the doc in U as well because without DerefMut impl you these methods aren't usable.

@JohnTitor JohnTitor added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. and removed A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Jul 7, 2020
Manishearth added a commit to Manishearth/rust that referenced this issue Jul 9, 2020
@Manishearth
Rollup merge of rust-lang#74107 - nbdd0121:rustdoc, r=GuillaumeGomez
c5a55ac 
Hide `&mut self` methods from Deref in sidebar if there are no `DerefMut` impl for the type.

This partially addresses rust-lang#74083.
Manishearth added a commit to Manishearth/rust that referenced this issue Jul 9, 2020
@Manishearth
Rollup merge of rust-lang#74107 - nbdd0121:rustdoc, r=GuillaumeGomez
69e30b5 
Hide `&mut self` methods from Deref in sidebar if there are no `DerefMut` impl for the type.

This partially addresses rust-lang#74083.
Manishearth added a commit to Manishearth/rust that referenced this issue Jul 9, 2020
@Manishearth
Rollup merge of rust-lang#74107 - nbdd0121:rustdoc, r=GuillaumeGomez
38541b7 
Hide `&mut self` methods from Deref in sidebar if there are no `DerefMut` impl for the type.

This partially addresses rust-lang#74083.
@lolbinarycat
Copy link
Contributor

triage: such items are now hidden from the "methods from Deref" section, and the link is no longer broken.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@nbdd0121 @tesuji @lolbinarycat @JohnTitor