oasis-tcs / sarif-spec

OASIS SARIF TC: Repository for development of the draft standard, where requests for modification should be made via Github Issues
https://github.com/oasis-tcs/sarif-spec
Other
169 stars 47 forks source link

Consider using the "relevant to understanding the result" wording also in notifications/relatedLocation #649

Open sthagen opened 4 months ago

sthagen commented 4 months ago

Kalle Olavi Niemitalo suggested in discussing pull request #643 where we add the relatedLocation field to the notification object:

I meant, I'd like this paragraph to use the "relevant to understanding the result" wording:

https://github.com/oasis-tcs/sarif-spec/blob/7fde9368c1ce946a1fd8fea5ffd032f5e5e49681/sarif-2.2/prose/edit/src/file-format-58-notification-object.md?plain=1#L106

instead of saying that the condition "applies" to the related locations. That way, it would be consistent with the complicated second part that says there may be locations to which the condition does not apply, and also consistent with how the relatedLocations property of the result object is described.

Originally posted by @KalleOlaviNiemitalo in https://github.com/oasis-tcs/sarif-spec/issues/643#issuecomment-2223610329