Skip to content
This repository has been archived by the owner on Nov 10, 2022. It is now read-only.

"About" page references rule severity numbers and probably shouldn't #261

Closed
platinumazure opened this issue May 30, 2016 · 2 comments
Closed
Labels
triage An ESLint team member will look at this issue soon

Comments

@platinumazure
Copy link
Member

From the "About" page:

Every rule:

  • Is standalone
  • Can be able to be turned off or on (nothing can be deemed “too important to turn off”)
  • Can be set to be a warning or error individually
  • Is turned on by providing a non-zero number and off by providing zero

The last bullet point is problematic for a few reasons:

  1. It mentions the numeric severities, which are still allowed but semi-deprecated in favor of strings
  2. In my opinion, it's way too specific about implementation/usage details for a high-level about page
  3. In my opinion, it is redundant given the point about ("Can be set to a warning or error individually")

I would advocate removing the last bullet point entirely, but I would also accept modifying it to mention numeric and string severity levels.

@eslintbot eslintbot added the triage An ESLint team member will look at this issue soon label May 30, 2016
@nzakas
Copy link
Member

nzakas commented Jun 1, 2016

Agreed. This file is on the main ESLint repo, though, so can you open an issue there?

@platinumazure
Copy link
Member Author

Thanks. Re-filed at eslint/eslint#6309.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
triage An ESLint team member will look at this issue soon
Projects
None yet
Development

No branches or pull requests

3 participants