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

Rules in Plugins docs incorrectly references environment #5421

Closed
jmm opened this Issue Feb 27, 2016 · 4 comments

Comments

Projects
None yet
4 participants
@jmm
Contributor

jmm commented Feb 27, 2016

This part is a mistake:

then you would set the environment in your configuration to be "myplugin/dollar-sign".

Should read something like:

then in your configuration you'd refer to the rule by the name myplugin/dollar-sign. Example: rules: {"myplugin/dollar-sign": 2}.

@platinumazure

This comment has been minimized.

Show comment
Hide comment
@platinumazure

platinumazure Feb 28, 2016

Member

It's definitely confusing, especially with an "Environments" section below it. Leaving the decision on final wording to a core team member.

Member

platinumazure commented Feb 28, 2016

It's definitely confusing, especially with an "Environments" section below it. Leaving the decision on final wording to a core team member.

@nzakas

This comment has been minimized.

Show comment
Hide comment
@nzakas

nzakas Feb 28, 2016

Member

I think the suggested wording is good.

Member

nzakas commented Feb 28, 2016

I think the suggested wording is good.

@nzakas nzakas added accepted and removed evaluating labels Feb 28, 2016

@platinumazure

This comment has been minimized.

Show comment
Hide comment
@platinumazure

platinumazure Feb 28, 2016

Member

@jmm Would you like to submit a pull request with your suggested wording?

Member

platinumazure commented Feb 28, 2016

@jmm Would you like to submit a pull request with your suggested wording?

@jmm

This comment has been minimized.

Show comment
Hide comment
@jmm

jmm Mar 4, 2016

Contributor

Thanks all. #5467. Added a set of quotes: rules => "rules".

Contributor

jmm commented Mar 4, 2016

Thanks all. #5467. Added a set of quotes: rules => "rules".

ilyavolodin added a commit that referenced this issue Mar 4, 2016

Merge pull request #5467 from jmm/plugins-docs-environment
Docs: Fix incorrect environment ref. in Rules in Plugins. (fixes #5421)

@eslint eslint bot locked and limited conversation to collaborators Feb 6, 2018

@eslint eslint bot added the archived due to age label Feb 6, 2018

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.