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: fix fixable example #15107

Merged
merged 1 commit into from Sep 27, 2021
Merged

Docs: fix fixable example #15107

merged 1 commit into from Sep 27, 2021

Conversation

QC-L
Copy link
Member

@QC-L QC-L commented Sep 27, 2021

Prerequisites checklist

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

[ ] 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)

The example should be:

module.exports = {
    meta: {
        fixable: "code" // or "whitespace"
    },
    create(context) {
        // your rule
    }
};

instead of

module.exports = function(context) {
    meta: {
        fixable: "code" // or "whitespace"
    },
    create(context) {
        // your rule
    }
};

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

The example should be:

```js
module.exports = {
    meta: {
        fixable: "code" // or "whitespace"
    },
    create(context) {
        // your rule
    }
};
```

instead of


```js
module.exports = function(context) {
    meta: {
        fixable: "code" // or "whitespace"
    },
    create(context) {
        // your rule
    }
};
```
@eslint-github-bot eslint-github-bot bot added the triage An ESLint team member will look at this issue soon label Sep 27, 2021
@aladdin-add aladdin-add added accepted There is consensus among the team that this change meets the criteria for inclusion bug ESLint is working incorrectly documentation Relates to ESLint's documentation and removed triage An ESLint team member will look at this issue soon labels Sep 27, 2021
Copy link
Member

@aladdin-add aladdin-add left a comment

LGTM! :)

@aladdin-add aladdin-add merged commit 16034f0 into eslint:master Sep 27, 2021
13 checks passed
@QC-L QC-L deleted the patch-1 branch Sep 27, 2021
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Mar 27, 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 Mar 27, 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 bug ESLint is working incorrectly documentation Relates to ESLint's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants