tc39 / tc39/ecmarkup

Structured headers don't seem to work with links in headers

Open
#420 2 comments 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

As used in Temporal:

      <h1>
        <a href="https://tc39.es/ecma402/#sec-canonicalizetimezonename">CanonicalizeTimeZoneName</a> (
          _timeZone_: a String value that is a valid time zone name as verified by IsValidTimeZoneName,
        )
      </h1>
      <dl class="header">
        <dt>description</dt>
        <dd>It returns the canonical and case-regularized form of _timeZone_.</dd>
      </dl>

yields

[2022-03-17T15:36:31.761Z] Error: spec/intl.html:53:14: expected `(`
[2022-03-17T15:36:31.763Z] Error: spec/intl.html:52:5: clauses with structured headers should have a type

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

Reproduce the failure with the structured header shown in spec/intl.html around lines 52–53. Start by tracing how ecmarkup parses a header containing an anchor link, then verify that the example is accepted without the reported errors and that its structured clauses are handled correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.