tc39 / tc39/ecmarkup

Can structured headers' <ins>/<del> UI be improved?

Open
#537 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
245
Forks
80
Avg merge
10h 46m
Merged PRs (30d)
2

Description

The fix in #533 enables <ins class="block"> and <del class="block"> to be used for the entire H1 of a structured header. This is an improvement, thanks! However:

  • The changes aren't represented in the left-hand table of contents pane, unlike <ins>/<del> used in unstructured headers
  • Deleted text is shown verbatim, in a huge H1 font, which is distracting for long parameter lists or long return type text. It also makes it harder to determine what actually has changed, because return types and parameter types are displayed differently (and far away from each other) in the <ins> block vs. the <del> block

Ideally, I'd be able to get the same reader-facing UI I can get with unstructured headers, which is that I can revise the AO name, a parameter name, a parameter type, and/or a return type, and only the changed parts would be shown in red or green background.

The screenshot below shows both problems, and shows examples in the left pane of unstructured headers' UI providing the desired behavior.

image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the structured-header implementation changed in #533 and compare it with the unstructured-header rendering and table-of-contents behavior. Done means the left-hand pane reflects structured-header changes and the reader-facing H1 highlights only changed names, parameter types, or return types rather than rendering whole inserted and deleted blocks.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.