Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove duplicate rule descriptions #16051

Closed
Tracked by #117
nzakas opened this issue Jun 24, 2022 · 2 comments · Fixed by #16052
Closed
Tracked by #117

Remove duplicate rule descriptions #16051

nzakas opened this issue Jun 24, 2022 · 2 comments · Fixed by #16052
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation good first issue Good for people who haven't worked on ESLint before
Projects

Comments

@nzakas
Copy link
Member

nzakas commented Jun 24, 2022

For the rule documentation page, there are currently two descriptions being shown: one right under the page title and one under the table of contents. Two tasks for each rule:

  1. The one under the table of contents is hardcoded into the markdown files and should be removed. These files are all in docs/src/rules.
  2. The one under the title is pulled from the rule's meta information, so we need to go through and capitalize those descriptions. These files are all in lib/rules.

Screenshot 2022-06-24 at 11-30-13 semi - ESLint - Pluggable JavaScript Linter

@eslint-github-bot eslint-github-bot bot added the triage An ESLint team member will look at this issue soon label Jun 24, 2022
@nzakas nzakas added documentation Relates to ESLint's documentation good first issue Good for people who haven't worked on ESLint before accepted There is consensus among the team that this change meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Jun 24, 2022
@eslint-github-bot eslint-github-bot bot added this to Needs Triage in Triage Jun 24, 2022
@nzakas nzakas transferred this issue from eslint/eslint.org Jun 24, 2022
@nzakas nzakas moved this from Needs Triage to Ready to Implement in Triage Jun 24, 2022
@amareshsm
Copy link
Member

I would like to work on this. I will send a PR.

@nzakas
Copy link
Member Author

nzakas commented Jun 25, 2022

Thanks!

@snitin315 snitin315 linked a pull request Jun 27, 2022 that will close this issue
1 task
Triage automation moved this from Ready to Implement to Complete Jun 30, 2022
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Dec 28, 2022
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Dec 28, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation good first issue Good for people who haven't worked on ESLint before
Projects
Archived in project
Triage
Complete
Development

Successfully merging a pull request may close this issue.

2 participants