codeql icon indicating copy to clipboard operation
codeql copied to clipboard

Java: Update the alert messages to better follow the style guide

Open erik-krogh opened this issue 3 years ago • 0 comments
trafficstars

The tests are failing, and that's expected (there is an internal PR that updates the expected output).

I've been working on making the alert-messages consistent across languages, and some fan out work from that is ensuring that the alert-messages follow the style guide (which I've also revised).

Fixes done as part of this PR:

  • Don't repeat the alert-location as a link.
  • Avoid non-descriptive links to "here", or non-descriptive mentions of "here".
  • Add single-quotes are code snippets.
  • Add full stop at the end of alert-messages.
  • Try to get more alert-messages to be consistent with other languages.
  • Use "depends on" in taint-tracking queries, and "flows to" in dataflow-queries.

Some of the messages become inconsistent with other languages, but I'm updating one language at a time, so some will get out of sync.

Some other PRs in this series: JS, Py, Rb, Go, C, C# (draft).
Style guide update.


Side-note: Copilot is great at writing consistent alert-messages. It reads the other tabs I have open. Screenshot 2022-09-22 at 19 57 10

erik-krogh avatar Sep 22 '22 04:09 erik-krogh