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

docs: add missing correct/incorrect containers #16087

Merged
merged 1 commit into from
Jul 6, 2022
Merged

docs: add missing correct/incorrect containers #16087

merged 1 commit into from
Jul 6, 2022

Conversation

mdjermanovic
Copy link
Member

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

I noticed when we have multiple examples of correct/incorrect code as separate code blocks, only the first code block has ✓/ x.

For example https://eslint.org/docs/latest/rules/no-restricted-imports#examples

image

What changes did you make? (Give an overview)

Wrapped each of the remaining code blocks in a ::: correct / ::: incorrect container, so that consecutive examples now look like this:

image

Is there anything you'd like reviewers to focus on?

Was it intended that ✓/ x appear for each code block?

@mdjermanovic mdjermanovic added documentation Relates to ESLint's documentation evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion labels Jul 2, 2022
@netlify
Copy link

netlify bot commented Jul 2, 2022 •
edited
Loading

✅ Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit 64f93a3
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/62c0777744deab0008138421
😎 Deploy Preview https://deploy-preview-16087--docs-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

nzakas
nzakas approved these changes Jul 6, 2022
View reviewed changes
Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Each code block should have its own icon when in a series.

@nzakas nzakas merged commit 4b79612 into main Jul 6, 2022
@nzakas nzakas deleted the more-correct-incorrect-containers branch July 6, 2022 00:58
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request Jul 18, 2022
Update dependency eslint to v8.20.0 (#1466)
2a3eba8 
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.19.0` -> `8.20.0`](https://renovatebot.com/diffs/npm/eslint/8.19.0/8.20.0) |

---

### Release Notes

<details>
<summary>eslint/eslint</summary>

### [`v8.20.0`](https://github.com/eslint/eslint/releases/tag/v8.20.0)

[Compare Source](eslint/eslint@v8.19.0...v8.20.0)

#### Features

-   [`ca83178`](eslint/eslint@ca83178) feat: catch preprocess errors ([#&#8203;16105](eslint/eslint#16105)) (JounQin)

#### Bug Fixes

-   [`30be0ed`](eslint/eslint@30be0ed) fix: no-warning-comments rule escapes special RegEx characters in terms ([#&#8203;16090](eslint/eslint#16090)) (Lachlan Hunt)
-   [`bfe5e88`](eslint/eslint@bfe5e88) fix: ignore spacing before `]` and `}` in comma-spacing ([#&#8203;16113](eslint/eslint#16113)) (Milos Djermanovic)

#### Documentation

-   [`845c4f4`](eslint/eslint@845c4f4) docs: Add website team details ([#&#8203;16115](eslint/eslint#16115)) (Nicholas C. Zakas)
-   [`5a0dfdb`](eslint/eslint@5a0dfdb) docs: Link to blog post in no-constant-binary-expression ([#&#8203;16112](eslint/eslint#16112)) (Jordan Eldredge)
-   [`bc692a9`](eslint/eslint@bc692a9) docs: remove install command ([#&#8203;16084](eslint/eslint#16084)) (Strek)
-   [`49ca3f0`](eslint/eslint@49ca3f0) docs: don't show toc when content not found ([#&#8203;16095](eslint/eslint#16095)) (Amaresh  S M)
-   [`ba19e3f`](eslint/eslint@ba19e3f) docs: enhance 404 page UI ([#&#8203;16097](eslint/eslint#16097)) (Amaresh  S M)
-   [`a75d3b4`](eslint/eslint@a75d3b4) docs: remove unused meta.docs.category field in working-with-rules page ([#&#8203;16109](eslint/eslint#16109)) (Brandon Scott)
-   [`cdc0206`](eslint/eslint@cdc0206) docs: add formatters page edit link ([#&#8203;16094](eslint/eslint#16094)) (Amaresh  S M)
-   [`4d1ed22`](eslint/eslint@4d1ed22) docs: preselect default theme ([#&#8203;16098](eslint/eslint#16098)) (Strek)
-   [`4b79612`](eslint/eslint@4b79612) docs: add missing correct/incorrect containers ([#&#8203;16087](eslint/eslint#16087)) (Milos Djermanovic)
-   [`09f6acb`](eslint/eslint@09f6acb) docs: fix UI bug on rules index and details pages ([#&#8203;16082](eslint/eslint#16082)) (Deepshika S)
-   [`f5db264`](eslint/eslint@f5db264) docs: remove remaining duplicate rule descriptions ([#&#8203;16093](eslint/eslint#16093)) (Milos Djermanovic)
-   [`32a6b2a`](eslint/eslint@32a6b2a) docs: Add scroll behaviour smooth ([#&#8203;16056](eslint/eslint#16056)) (Amaresh  S M)

#### Chores

-   [`bbf8df4`](eslint/eslint@bbf8df4) chore: Mark autogenerated release blog post as draft ([#&#8203;16130](eslint/eslint#16130)) (Nicholas C. Zakas)
-   [`eee4306`](eslint/eslint@eee4306) chore: update internal lint dependencies ([#&#8203;16088](eslint/eslint#16088)) (Bryan Mishkin)
-   [`9615a42`](eslint/eslint@9615a42) chore: update formatter examples template to avoid markdown lint error ([#&#8203;16085](eslint/eslint#16085)) (Milos Djermanovic)
-   [`62541ed`](eslint/eslint@62541ed) chore: fix markdown linting error ([#&#8203;16083](eslint/eslint#16083)) (唯然)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox.

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzMi4xMTcuMSIsInVwZGF0ZWRJblZlciI6IjMyLjExNy4xIn0=-->

Co-authored-by: cabr2-bot <cabr2.help@gmail.com>
Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1466
Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org>
Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
@sync-by-unito sync-by-unito bot mentioned this pull request Aug 1, 2022
Closed
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Jan 3, 2023
@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 Jan 3, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@nzakas nzakas nzakas approved these changes

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 evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mdjermanovic @nzakas