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: Way to fold documentation of Methods from Deref<Target = ...> #127470

Closed
tesuji opened this issue Jul 7, 2024 · 0 comments · Fixed by #127474
Closed

rustdoc: Way to fold documentation of Methods from Deref<Target = ...> #127470

tesuji opened this issue Jul 7, 2024 · 0 comments · Fixed by #127474
Labels
A-rustdoc-ui Area: rustdoc UI (generated HTML) C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.

Comments

@tesuji
Copy link
Contributor

tesuji commented Jul 7, 2024

Take Vec for example, there are fold-able impl blocks, but the inline impl Deref block
cannot be folded. Sometimes I just wanna skim over the doc, and skip uninterested doc block
by folding them.

image

@rustbot label +A-rustdoc-ui T-rustdoc T-rustdoc-frontend C-enhancement

> rustc --version
Nightly version: 1.81.0-nightly
(2024-07-06 ed7e35f3494045fa1194)
@rustbot rustbot added needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. A-rustdoc-ui Area: rustdoc UI (generated HTML) C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. labels Jul 7, 2024
@saethlin saethlin removed the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Jul 8, 2024
@tesuji tesuji mentioned this issue Jul 8, 2024
Merged
1 task
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this issue Sep 1, 2024
@GuillaumeGomez
Rollup merge of rust-lang#127474 - tesuji:foldable-inline-derefs, r=t…
46f0882 
…-rustdoc

doc: Make block of inline Deref methods foldable

After:
![image](https://github.com/rust-lang/rust/assets/15225902/3e8ab320-dbf7-436f-9be0-d0ef82664663)
Before:
![image](https://github.com/rust-lang/rust/assets/15225902/f6f7635d-d4c3-437e-a2d9-147726287b05)

Fix  rust-lang#127470.

Current status:
- [x] Bug when hovering over title "Methods from ...": The anchor sign $ overlaps with `[-]`: rust-lang#127474 (comment)
    => Fixed by rust-lang#127474 (comment)
workingjubilee added a commit to workingjubilee/rustc that referenced this issue Sep 2, 2024
@workingjubilee
Rollup merge of rust-lang#127474 - tesuji:foldable-inline-derefs, r=t…
766102f 
…-rustdoc

doc: Make block of inline Deref methods foldable

After:
![image](https://github.com/rust-lang/rust/assets/15225902/3e8ab320-dbf7-436f-9be0-d0ef82664663)
Before:
![image](https://github.com/rust-lang/rust/assets/15225902/f6f7635d-d4c3-437e-a2d9-147726287b05)

Fix  rust-lang#127470.

Current status:
- [x] Bug when hovering over title "Methods from ...": The anchor sign $ overlaps with `[-]`: rust-lang#127474 (comment)
    => Fixed by rust-lang#127474 (comment)
@bors bors closed this as completed in c90991d Sep 2, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this issue Sep 2, 2024
@rust-timer
Unrolled build for rust-lang#127474
8829193 
Rollup merge of rust-lang#127474 - tesuji:foldable-inline-derefs, r=t-rustdoc

doc: Make block of inline Deref methods foldable

After:
![image](https://github.com/rust-lang/rust/assets/15225902/3e8ab320-dbf7-436f-9be0-d0ef82664663)
Before:
![image](https://github.com/rust-lang/rust/assets/15225902/f6f7635d-d4c3-437e-a2d9-147726287b05)

Fix  rust-lang#127470.

Current status:
- [x] Bug when hovering over title "Methods from ...": The anchor sign $ overlaps with `[-]`: rust-lang#127474 (comment)
    => Fixed by rust-lang#127474 (comment)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-rustdoc-ui Area: rustdoc UI (generated HTML) C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: Make block of inline Deref methods foldable tesuji/rustc
3 participants
@saethlin @tesuji @rustbot