-
-
Notifications
You must be signed in to change notification settings - Fork 5k
Clean up key-spacing documentation #9900
Copy link
Copy link
Closed
Labels
acceptedThere is consensus among the team that this change meets the criteria for inclusionThere is consensus among the team that this change meets the criteria for inclusionarchived due to ageThis issue has been archived; please open a new issue for any further discussionThis issue has been archived; please open a new issue for any further discussiondocumentationRelates to ESLint's documentationRelates to ESLint's documentationgood first issueGood for people who haven't worked on ESLint beforeGood for people who haven't worked on ESLint beforehelp wantedThe team would welcome a contribution from the community for this issueThe team would welcome a contribution from the community for this issue
Description
Metadata
Metadata
Assignees
Labels
acceptedThere is consensus among the team that this change meets the criteria for inclusionThere is consensus among the team that this change meets the criteria for inclusionarchived due to ageThis issue has been archived; please open a new issue for any further discussionThis issue has been archived; please open a new issue for any further discussiondocumentationRelates to ESLint's documentationRelates to ESLint's documentationgood first issueGood for people who haven't worked on ESLint beforeGood for people who haven't worked on ESLint beforehelp wantedThe team would welcome a contribution from the community for this issueThe team would welcome a contribution from the community for this issue
As of ESLint v4.16.0, the
key-spacingdocumentation is difficult to understand. All of the options are presented in a single list in the Options section, but there are actually multiple categories of options, and some options can be nested under other options, and it's not clear what is allowed from reading the top of the file. I think we should reorganize the documentation to more clearly describe what configurations are allowed without relying so much on examples.