tc39 / tc39/ecmarkup

Make grammar styling a bit nicer

Open
#17 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

http://tc39.github.io/ecmascript-asyncawait/#AsyncFunctionDeclaration-static-semantics could be prettier:

screenshot 31

Some ideas (brainstorming):

  • Don't allow breaking in component parts, e.g. "[no LineTerminator here]" should always stay on one line.
  • New line and indent after the colon?
  • Turn off linebreaking entirely? (Be careful this doesn't break mobile.)
  • Try to make line breaks consistent, either by the author inserting them or by some heuristic? E.g. a line break before each of "function" and "{AsyncFunctionBody}" might work.
  • Change the font or font color or...?

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 with the AsyncFunctionDeclaration example linked in the issue and compare its rendered grammar styling with the attached screenshot. The issue presents several competing ideas rather than a decided change, so the work is done only after a specific styling approach is agreed and its effect on mobile is checked.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.