w3c / w3c/clreq

ReSpec warnings on unused dfns

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

Nobody has claimed this yet.

Dominant language
HTML
Stars
809
Forks
66
Avg merge
19m
Merged PRs (30d)
1

Description

有一些术语我们在文中用<dfn>定义了,但是没有任何地方链接到该定义,所以ReSpec提出了warning。为了清除ReSpec提出的warning,有多种可能的解决方法:

  1. 删除<dfn>,变回普通的文字
  2. 添加lint-ignore类,让ReSpec跳过这个词的检查
  3. 在术语表里定义这个词(另见 issue #325),并删除这个<dfn>

目前,这些术语包括:

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 reviewing the unused terms listed in the issue and the related pull request #475 and issue #472, then inspect the ReSpec warnings they produce. Decide for each term whether to remove the definition, add lint-ignore, or move it to the glossary as discussed in issue #325; done means the warnings are cleared.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.