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

Documentation broken for no-multiple-empty-lines #13432

Closed
walliski opened this issue Jun 22, 2020 · 3 comments · Fixed by #13433
Closed

Documentation broken for no-multiple-empty-lines #13432

walliski opened this issue Jun 22, 2020 · 3 comments · Fixed by #13433
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 documentation Relates to ESLint's documentation rule Relates to ESLint's core rules

Comments

@walliski
Copy link

walliski commented Jun 22, 2020

The version of ESLint you are using.
7.3.0

The problem you want to solve.
Documentation for the no-multiple-empty-lines rule is wrong. The examples are identical for breaking and non-breaking code. This was introduced in 1ee3c42, probably due to some auto-formatting.

Your take on the correct solution to problem.
Revert parts of the documentation to match the intended behavior of the rule.

Are you willing to submit a pull request to implement this change?
Not at this point, no.

Also on another note. Not sure if I am not smart, but could not really figure out which category of issue these kind of changes goes into 🤔

@walliski walliski added core Relates to ESLint's core APIs and features enhancement This change enhances an existing feature of ESLint triage An ESLint team member will look at this issue soon labels Jun 22, 2020
@anikethsaha
Copy link
Member

Thanks for the report.

Yea I think this is an inconsistency.

@mdjermanovic mdjermanovic added accepted There is consensus among the team that this change meets the criteria for inclusion documentation Relates to ESLint's documentation and removed core Relates to ESLint's core APIs and features enhancement This change enhances an existing feature of ESLint triage An ESLint team member will look at this issue soon labels Jun 22, 2020
@mdjermanovic
Copy link
Member

@walliski thanks for the issue!

I'm working on it.

Also, you're right, we should probably have a separate issue template for reporting documentation problems, or maybe not assume that "Non-rule change request" must be a core enhancement request :)

@mdjermanovic
Copy link
Member

This should be fixed by #13433.

Just a note about maxEOF examples: they'll still look identical if the document is viewed on github, because github doesn't render any empty lines at the end of code blocks. They should be okay at https://eslint.org/docs/rules/no-multiple-empty-lines

@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Dec 31, 2020
@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 Dec 31, 2020
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 documentation Relates to ESLint's documentation rule Relates to ESLint's core rules
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants