Skip to content

Commit e53706a

Browse files
authored
chore: readme copy fixes
1 parent 5a69fb4 commit e53706a

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,11 @@ See the [demo](docs/README.md) for a full set of examples.
7373

7474
`result.html` is built to be accessible by default (with WCAG 2.1 AA in mind):
7575

76-
- The whole explanation is one labelled group: `<div class="pfem" role="group" lang="…" aria-labelledby="…">`, named by its title, with `lang` taken from the copydeck so screen readers pronounce localised copy correctly (`3.1.2 Language of Parts`). `role="group"` (not a landmark) keeps things uncluttered when several explanations render on one page
77-
- The title is deliberately not a heading. Heading level depends on the surrounding page outline, which a library can't know, so the title supplies the group's accessible name instead. If you want it in your heading outline, render your own heading from `result.title` and use `result.html` (or the structured fields) for the body
78-
- Code is marked up as code; inline tokens use `<code>` and blocks use `<pre><code>`
79-
- The suggested fix has a visible "Suggested fix" label; the original traceback stays in a native `<details>`/`<summary>`
76+
- The whole explanation is one labelled group: `<div class="pfem" role="group" lang="…" aria-labelledby="…">`, named by its title, with `lang` taken from the copydeck so screen readers pronounce localised copy correctly
77+
- `role="group"` keeps things uncluttered when several explanations render on one page
78+
- The title is deliberately not a heading, the title supplies the group's accessible name instead. If you want an actual heading, render your own from `result.title` and use `result.html` (or the structured fields) for the body
79+
- Code is marked up as such; inline tokens use `<code>` and blocks use `<pre><code>`
80+
- The suggested fix has a visible "Suggested fix" label; the original traceback stays in `<details>`/`<summary>`
8081
- Element ids are randomised per call so `aria-labelledby` remains unambiguous when multiple explanations coexist on a page
8182

8283
### Your responsibilities

0 commit comments

Comments
 (0)