tc39 / tc39/ecmarkup

`<var>`s inside `<pre>`s get preprocessed away

Open
#84 3 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

<pre><code class="lang-javascript">global1.Zone.current; // succeeds
global2.Zone.current; // throws: <var>currentRealm</var> = <var>realm1</var>; <var>thisRealm</var> = <var>functionRealm</var> = <var>realm2</var>

const getter1 = Object.getOwnPropertyDescriptor(global1.Zone, "current").get;
const getter2 = Object.getOwnPropertyDescriptor(global2.Zone, "current").get;

getter1.call(global2.Zone); // throws: <var>currentRealm</var> = <var>functionRealm</var> = <var>realm1</var>; <var>thisRealm</var> = <var>realm2</var>
getter2.call(global1.Zone); // throws: <var>currentRealm</var> = <var>thisRealm</var> = <var>realm1</var>; <var>functionRealm</var> = <var>realm2</var>
</code></pre>

the output no longer contains the <var>. I think in general it's good to be able to call attention to certain things typographically inside examples even if you couldn't type them that way in a text editor, e.g. <var>, <mark>, <ins>, <del>, etc.

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

Use the HTML example in the issue as the reproduction case and inspect the preprocessing path that removes the elements inside

. Done means typographic tags such as , , , and  remain in the generated output while the code example still renders correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, typescript
Domain
documentation
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.