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

rustdoc bug: page "ByteStr" is outright wrong: it shows methods for [MaybeUninit<...>] #137083

Closed
safinaskar opened this issue Feb 15, 2025 · 7 comments · Fixed by #138574
Closed

rustdoc bug: page "ByteStr" is outright wrong: it shows methods for [MaybeUninit<...>] #137083

safinaskar opened this issue Feb 15, 2025 · 7 comments · Fixed by #138574
Assignees
@lolbinarycat
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

@safinaskar
Copy link
Contributor

rustdoc bug: page ByteStr is outright wrong: it shows methods for [MaybeUninit<...>]

Information on page https://doc.rust-lang.org/nightly/std/bstr/struct.ByteStr.html is currently totally wrong.

After inherent methods we see "Methods from Deref<Target = [u8]>". But then instead of methods of [u8], we actually see methods of [MaybeUninit<T>]!!! Immediately after header "Methods from Deref<Target = [u8]>" we see method write_copy_of_slice, which is actually [MaybeUninit<T>] method!

@rustbot label: +T-rustdoc
@safinaskar safinaskar added the C-bug Category: This is a bug. label Feb 15, 2025
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Feb 15, 2025
@safinaskar

This comment has been minimized.

Sign in to view
@rustbot rustbot added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Feb 15, 2025
@safinaskar

This comment has been minimized.

Sign in to view
@rustbot rustbot added the T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) label Feb 15, 2025
@safinaskar

This comment has been minimized.

Sign in to view
@rustbot rustbot removed T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Feb 15, 2025
@safinaskar

This comment has been minimized.

Sign in to view
@rustbot rustbot added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Feb 15, 2025
@safinaskar

This comment has been minimized.

Sign in to view
@rustbot rustbot removed the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Feb 15, 2025
@safinaskar

This comment has been minimized.

Sign in to view
@rustbot rustbot added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Feb 15, 2025
@theemathas
Copy link
Contributor

Duplicate of #24686

@lolbinarycat lolbinarycat self-assigned this Feb 20, 2025
@Noratrieb Noratrieb removed the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Mar 1, 2025
@lolbinarycat lolbinarycat mentioned this issue Mar 16, 2025
Merged
4 tasks
@bors bors closed this as completed in abc6784 Mar 24, 2025
rust-timer added a commit to rust-lang-ci/rust that referenced this issue Mar 24, 2025
@rust-timer
Unrolled build for rust-lang#138574
dfc2d4e 
Rollup merge of rust-lang#138574 - lolbinarycat:rustdoc-deref-24686-v2, r=GuillaumeGomez

rustdoc: be more strict about "Methods from Deref"

fixes rust-lang#137083
fixes rust-lang#24686

Currently done:
* [x] fix `render_assoc_items_inner
* [x] fix sidebar logic
* [x] port test from rust-lang#137564
* [x] add test for sidebar items

Note that this does not yet fix the sidebar logic.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lolbinarycat lolbinarycat

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

Successfully merging a pull request may close this issue.

rustdoc: be more strict about "Methods from Deref" lolbinarycat/rust
5 participants
@safinaskar @theemathas @lolbinarycat @rustbot @Noratrieb