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 accessibility: use real headers for doc items #87390

Closed
wants to merge 10 commits into from
Closed

Rustdoc accessibility: use real headers for doc items #87390

wants to merge 10 commits into from

Conversation

notriddle
Copy link
Contributor

@notriddle notriddle commented Jul 22, 2021 •
edited
Loading

@notriddle
Rustdoc accessibility: use real headers for doc items
458e721 
This is a pretty annoying workaround: the specifications literally
contradict each other on the matter of whether headers may be nested
inside of summaries. We need the headers for people who use outline
mode to browse rustdoc, mostly in screen readers, and the headers
need to be inside the summary tag so that they're visible when the
details tag is collapsed.

HTML5 says it's okay, but the ordinary button semantics in ARIA say
that headers nested in buttons are ignored, and summary is a button.
Which means some screen readers, like NVDA, work, while others,
like JAWS, don't.
@rust-highfive
Copy link
Collaborator

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez

@rust-highfive
Copy link
Collaborator

r? @CraftSpider

(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 Jul 22, 2021
@notriddle notriddle force-pushed the notriddle/rustdoc-headers-patch branch from 1b7232f to 0147ce7 Compare July 22, 2021 22:48
@camelid camelid added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Jul 23, 2021
@ahicks92
Copy link
Contributor

To get ahead of the "can you check it please": yes, this works at least with my setup, and it looks like you just made my day.

Also apparently I missed the table of contents headers one if that's not part of this one, but that's also very nice.

@GuillaumeGomez
Copy link
Member

The notable tooltip is broken too:

Screenshot from 2021-07-23 11-52-17

@jyn514 jyn514 added the beta-nominated Nominated for backporting to the compiler in the beta channel. label Jul 23, 2021
notriddle and others added 2 commits July 23, 2021 07:10
@notriddle @GuillaumeGomez
Update src/test/rustdoc/assoc-consts.rs
0e0ca26 
Co-authored-by: Guillaume Gomez <guillaume1.gomez@gmail.com>
@notriddle @GuillaumeGomez
Update src/test/rustdoc/assoc-types.rs
2f4c4c3 
Co-authored-by: Guillaume Gomez <guillaume1.gomez@gmail.com>
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@notriddle
Copy link
Contributor Author

@GuillaumeGomez okay, I fixed the tooltip and all of the test cases.

@bors
Copy link
Contributor

bors commented Jul 25, 2021

@notriddle: 🔑 Insufficient privileges: Not in reviewers

@GuillaumeGomez
Copy link
Member

@bors: r+ squash

@bors
Copy link
Contributor

bors commented Jul 25, 2021

📌 Commit 7e888bd has been approved by GuillaumeGomez

@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 Jul 25, 2021
bors added a commit to rust-lang-ci/rust that referenced this pull request Jul 25, 2021
@bors
Auto merge of rust-lang#87390 - notriddle:notriddle/rustdoc-headers-p…
5782f01 
…atch, r=GuillaumeGomez

Rustdoc accessibility: use real headers for doc items

Part of rust-lang#87059

Partially reverts rust-lang#84703

Preview at: https://notriddle.com/notriddle-rustdoc-test/real-headers/std/index.html
@bors
Copy link
Contributor

bors commented Jul 25, 2021

⌛ Testing commit 7e888bd with merge 5782f01...

@bors
Copy link
Contributor

bors commented Jul 26, 2021

☀️ Test successful - checks-actions
Approved by: GuillaumeGomez
Pushing 5782f01 to master...

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label Jul 26, 2021
@bors bors mentioned this pull request Jul 26, 2021
Closed
@pietroalbini
Copy link
Member

This has been merged.

@GuillaumeGomez GuillaumeGomez added the beta-accepted Accepted for backporting to the compiler in the beta channel. label Jul 26, 2021
@pietroalbini pietroalbini mentioned this pull request Jul 26, 2021
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Jul 26, 2021
@bors
Auto merge of rust-lang#87476 - pietroalbini:stable-next, r=Mark-Simu…
a178d03 
…lacrum

Prepare 1.54.0 release

This PR builds the stable artifacts for the 1.54.0 release. Backports included:

* rust-lang#86696
*  rust-lang#87167
* rust-lang#87210

I was *not* able to cherry-pick rust-lang#87390 as that didn't apply cleanly to the stable branch. `@GuillaumeGomez` `@notriddle` could it be possible to get a PR targeting `stable` backporting that fix?

Also, this **enables** incremental compilation on the stable channel.

r? `@Mark-Simulacrum`
cc `@rust-lang/release`
notriddle pushed a commit to notriddle/rust that referenced this pull request Jul 26, 2021
@bors @notriddle
Rustdoc accessibility: use real headers for doc items
52fc846 
Part of rust-lang#87059

Partially reverts rust-lang#84703

Backport of rust-lang#87390

Preview at: https://notriddle.com/notriddle-rustdoc-test/real-headers/std/index.html
@notriddle notriddle mentioned this pull request Jul 26, 2021
Closed
@pietroalbini pietroalbini added beta-accepted Accepted for backporting to the compiler in the beta channel. beta-nominated Nominated for backporting to the compiler in the beta channel. and removed beta-accepted Accepted for backporting to the compiler in the beta channel. beta-nominated Nominated for backporting to the compiler in the beta channel. labels Jul 27, 2021
@pietroalbini
Copy link
Member

Actually, this will also need to be backported to 1.55.0 beta as it was merged after the beta cutoff.

@pietroalbini pietroalbini mentioned this pull request Jul 27, 2021
Merged
@pietroalbini
Copy link
Member

Included in #87508

@pietroalbini pietroalbini removed the beta-nominated Nominated for backporting to the compiler in the beta channel. label Jul 27, 2021
bors added a commit to rust-lang-ci/rust that referenced this pull request Jul 28, 2021
@bors
Auto merge of rust-lang#87508 - pietroalbini:beta-next, r=Mark-Simula…
739f8f0 
…crum

Prepare beta 1.55.0

Included backports:

* rust-lang#86696
* rust-lang#87390 (squashed)

Reverted:

* rust-lang#86623

cc `@rust-lang/release` `@Mark-Simulacrum`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@GuillaumeGomez GuillaumeGomez GuillaumeGomez approved these changes

Assignees

@CraftSpider CraftSpider

Labels
beta-accepted Accepted for backporting to the compiler in the beta channel. merged-by-bors This PR was explicitly merged by bors. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. 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 this pull request may close these issues.
10 participants
@notriddle @rust-highfive @ahicks92 @GuillaumeGomez @rust-log-analyzer @bors @pietroalbini @CraftSpider @jyn514 @camelid