mdn / mdn/data

Improvements on at-rule syntax description

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

Nobody has claimed this yet.

accepting PR
Dominant language
JavaScript
Stars
787
Forks
216
Avg merge
1d 5h
Merged PRs (30d)
6

Description

There are some syntax description issues in css/at-rule.json:

  • @charset \"<charset>\"; is quite incorrect, should be @charset <string> ;
  • @counter-style has a description of block, but declaration refers to wrong types (i.e. system: <counter-system>; but system key in descriptors)
  • @font-face had a problem with wrong reference like in @counter-style syntax, but I fixed it in #221
  • <group-rule-body> is wrong for the block of @viewport (should be a list of descriptors)

I think we need to change the description of @counter-style, @font-face and @viewport, since those at-rules have a limited list of descriptors and block syntax can be generated from a descriptors section. The rest at-rule descriptions should be revisited too.
I can bring a PR later if there is no blockers for changes (like MDN pages).

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 in css/at-rule.json and inspect the syntax descriptions for @charset, @counter-style, @font-face, and @viewport, comparing each block with its descriptors section. Check the related correction in issue #221 for context. Done means the named at-rules use the correct syntax references and the remaining at-rule descriptions have been revisited.

Written by the indexing model from the issue text.

Assessment

Tech stack
css
Domain
documentation, web-dev
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.