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: About page mentions rule severity numbers and probably shouldn't #6309

Closed
platinumazure opened this issue Jun 1, 2016 · 2 comments
Closed
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

Comments

@platinumazure
Copy link
Member

platinumazure commented Jun 1, 2016

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 above ("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.

(Originally filed at eslint/archive-website#261)

@eslintbot eslintbot added the triage An ESLint team member will look at this issue soon label Jun 1, 2016
@platinumazure platinumazure changed the title Docs: About page mentions numerical severities and probably shouldn't Docs: About page mentions rule severity numbers and probably shouldn't Jun 1, 2016
@platinumazure platinumazure added documentation Relates to ESLint's documentation evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Jun 1, 2016
@platinumazure
Copy link
Member Author

@nzakas Could you please share your thoughts on this point:

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

Should the bullet point be removed or modified?

I'm happy to take this on once I know the correct approach 😄

@nzakas nzakas added bug ESLint is working incorrectly accepted There is consensus among the team that this change meets the criteria for inclusion and removed evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion labels Jun 5, 2016
@nzakas
Copy link
Member

nzakas commented Jun 5, 2016

I think removing it is fine

@nzakas nzakas closed this as completed in 1cc4356 Jun 6, 2016
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Feb 6, 2018
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Feb 6, 2018
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

No branches or pull requests

3 participants