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: Clarify that ignorePattern should be a string (refs #13029) #13718

Merged
merged 2 commits into from Sep 26, 2020

Conversation

btmills
Copy link
Member

@btmills btmills commented Sep 26, 2020

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 autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

In #13029, the author based the docs on ignorePattern on lines-around-comment, which says the option should be a "regular expression". Here I update both places to clarify that the option should be a string that will be used to construct a regular expression.

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

@btmills btmills added rule documentation accepted labels Sep 26, 2020
@btmills btmills requested a review from mdjermanovic Sep 26, 2020
@btmills btmills requested a review from mdjermanovic Sep 26, 2020
Copy link
Member

@mdjermanovic mdjermanovic left a comment

LGTM! Waiting for CI to finish before merging.

@mdjermanovic mdjermanovic merged commit 6919fbb into master Sep 26, 2020
12 checks passed
@mdjermanovic mdjermanovic deleted the ignorepattern-docs branch Sep 26, 2020
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Mar 26, 2021
@eslint-github-bot eslint-github-bot bot added the archived due to age label Mar 26, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted archived due to age documentation rule
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants