Shared: Overhaul the AlertFiltering QLDoc#20047
Conversation
|
This is a documentation update follow-up to #19943, concerning support for approximate locations. (That PR changes #19943 treats support for approximate locations as an implementation detail that is not documented (nor expected to be documented.) This PR treats the same support for approximate locations as the new specification for |
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation for the AlertFiltering module to clarify and strengthen the contract for the restrictAlertsTo and restrictAlertsToExactLocation extensible predicates. The changes modify how alert location matching is defined - restrictAlertsTo now matches locations that intersect with a line range rather than just checking the first line, and restrictAlertsToExactLocation now matches locations that wholly contain a character range rather than requiring exact matches.
- Updated parameter names and documentation for
restrictAlertsToto clarify line range intersection behavior - Modified
restrictAlertsToExactLocationdocumentation to specify character range containment semantics - Simplified and clarified various docstring explanations throughout the module
This commit strengthens the contract for the restrictAlertsTo and the restrictAlertsToExactLocation extensible predicates. - restrictAlertsTo is now documented to match any alert location that intersects with a specified line range. (Previously an alert location matches only when its first line is in a specified line range.) - restrictAlertsToExactLocation is now documented to match any alert location that wholly contains a specific character range. (Previously an alert location matchis only when it is exactly the same as a specified character range.) It also contains misc wording changes for clarity.
7083d81 to
b20521b
Compare
This PR strengthens the contract for the
restrictAlertsToand therestrictAlertsToExactLocationextensible predicates.restrictAlertsTois now documented to match any alert location that intersects with a specified line range. (Previously an alert location matches only when its first line is in a specified line range.)restrictAlertsToExactLocationis now documented to match any alert location that wholly contains a specific character range. (Previously an alert location matchis only when it is exactly the same as a specified character range.)It also contains misc wording changes for clarity.