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

docs: update docs and description of require-unicode-regexp #19205

Conversation

lumirlumir
Copy link
Contributor

@lumirlumir lumirlumir commented Dec 3, 2024

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:

What changes did you make? (Give an overview)

Hello,

I've made the following updates to require-unicode-regexp.js and require-unicode-regexp.md:

  1. Added missing backticks to RegExp:

    • In other descriptions (as shown in the screenshot below), RegExp is wrapped in backticks, but it was missing here.

    image

  2. Aligned @fileoverview with the description:

    • The @fileoverview comment didn’t match the description, so I made them consistent.

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

Nothing.

@lumirlumir lumirlumir requested a review from a team as a code owner December 3, 2024 05:28
@eslint-github-bot eslint-github-bot bot added the documentation Relates to ESLint's documentation label Dec 3, 2024
@github-actions github-actions bot added the rule Relates to ESLint's core rules label Dec 3, 2024
Copy link

netlify bot commented Dec 3, 2024

Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit dfbf8fa
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/674e9707949905000881f4b2
😎 Deploy Preview https://deploy-preview-19205--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 configuration.

Copy link

netlify bot commented Dec 3, 2024

Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit dbb1de5
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/674f0315bcee4900089a8ccf
😎 Deploy Preview https://deploy-preview-19205--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 configuration.

docs/src/rules/require-unicode-regexp.md Outdated Show resolved Hide resolved
docs/src/rules/require-unicode-regexp.md Outdated Show resolved Hide resolved
lib/rules/require-unicode-regexp.js Outdated Show resolved Hide resolved
lumirlumir and others added 5 commits December 3, 2024 22:00
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
…exp' of https://github.com/lumirlumir/fork-eslint into docs-update-docs-and-description-of-require-unicode-regexp
@lumirlumir
Copy link
Contributor Author

lumirlumir commented Dec 3, 2024

@mdjermanovic Thanks for the review!

I've updated code based on your feedback.

Copy link
Member

@mdjermanovic mdjermanovic left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@mdjermanovic mdjermanovic merged commit 8a941cb into eslint:main Dec 3, 2024
27 checks passed
@lumirlumir lumirlumir deleted the docs-update-docs-and-description-of-require-unicode-regexp branch December 3, 2024 13:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relates to ESLint's documentation rule Relates to ESLint's core rules
Projects
Status: Complete
Development

Successfully merging this pull request may close these issues.

2 participants