Docs: improve id-match usage advice #9544
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the purpose of this pull request? (put an "X" next to item)
[x] Documentation update
What changes did you make? (Give an overview)
The current documentation for
id-match
mentions that the rule has performance problems for complex rules. This seems a bit misleading to me; the rule does have to match a user-provided regex against all identifiers, but I think the documentation exaggerates how important this problem is in practice. Matching a regex against all identifiers seems unlikely to be a major performance bottleneck compared to some other rules which do much more performance-intensive tasks.(I noticed this as a result of #9538.)
Is there anything you'd like reviewers to focus on?
Nothing in particular