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.

Sign up for GitHub

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

Jump to bottom

[new docs site] Add ::: correct and ::: incorrect in all rule docs #16013

Closed
Tracked by #117
mdjermanovic opened this issue Jun 17, 2022 · 5 comments
Closed
Tracked by #117

[new docs site] Add ::: correct and ::: incorrect in all rule docs #16013

mdjermanovic opened this issue Jun 17, 2022 · 5 comments
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation
Projects
Triage

Comments

@mdjermanovic
Copy link
Member

In all rule docs, we should wrap correct examples in ::: correct, and incorrect examples in ::: incorrect containers.

This adds ✓ or ❌ to the upper right corner.

An example is semi rule, updated in #15998.

https://new.eslint.org/docs/head/rules/semi

image
@eslint-github-bot eslint-github-bot bot added this to Needs Triage in Triage Jun 17, 2022
@eslint-github-bot eslint-github-bot bot added the triage An ESLint team member will look at this issue soon label Jun 17, 2022
@mdjermanovic mdjermanovic added documentation Relates to ESLint's documentation and removed triage An ESLint team member will look at this issue soon labels Jun 17, 2022
@mdjermanovic mdjermanovic mentioned this issue Jun 17, 2022
Closed
21 tasks
@DeepshikaS
Copy link
Contributor

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

@harish-sethuraman
Copy link
Member

harish-sethuraman commented Jun 18, 2022 •
edited

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

There are lot of rules. Would you like to split effort? I can help as well

@DeepshikaS DeepshikaS mentioned this issue Jun 18, 2022
Merged
1 task
@harish-sethuraman harish-sethuraman mentioned this issue Jun 21, 2022
Closed
1 task
@DeepshikaS
Copy link
Contributor

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

There are lot of rules. Would you like to split effort? I can help as well

Hey, I've missed this comment. I had already started working on this pr-#16013 (comment) and didn't think it was that complex even if done manually. Initially I had started doing this manually, but while working on the add version pr-#16022 I found out that this can also be done via script and did using that.

@mdjermanovic
Copy link
Member Author

Fixed by #16021

Triage automation moved this from Needs Triage to Complete Jun 22, 2022
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Dec 20, 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 20, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation
Projects
Triage
Archived in project
Triage
Complete
Milestone
No milestone
Development

No branches or pull requests
4 participants
@harish-sethuraman @DeepshikaS @mdjermanovic and others