Improve documentation about overriding rules #14962
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
enhancement
This change enhances an existing feature of ESLint
Projects
The version of ESLint you are using.
7.32.0
The problem you want to solve.
The documentation in Extending Configuration Files does a good job to explain the mechanism of extending or overriding rules coming from a base config. But the thing is that I recently have been struggling a bit to figure out how rules with options given as object are resulting from a base config. The question raised about a deriving rule was:
Sure it does the latter but that's not clear to the reader.
Your take on the correct solution to problem.
So my suggestion here is to add another example of overriding a rule which has options given as an object instead of just a single string value just to make it crystal clear about how the mechanism works.
The suggested documentation is expected to become like so:
Are you willing to submit a pull request to implement this change?
Yes, sure!
The text was updated successfully, but these errors were encountered: