[PATCH] D76833: [CodingStandards] Document coding standard for error and warning messages

[Hubert Tong via Phabricator via llvm-commits]

hubert.reinterpretcast added a comment.

Thanks for doing this. The guidance is really helpful to have.



================
Comment at: llvm/docs/CodingStandards.rst:330
+styles commonly produced by other tools, start the first sentence with a
+lower-case letter, and finish the last sentence without a period.
+
----------------
Suggestion:
[ ... ] without a period if it were to end in one otherwise. For example, "did you forget ';'?" should still end in a question mark.


================
Comment at: llvm/docs/CodingStandards.rst:345
+
+As with other coding standards, individual projects, such as the clang static
+analyzer, may have pre-existing styles that do not conform to this. If a
----------------
Should "Clang" be capitalized here?


================
Comment at: llvm/docs/CodingStandards.rst:349
+that style instead. Otherwise, this standard applies to all LLVM tools,
+including clang, clang-tidy and so on.
+
----------------
I think a comma before "and so on" is appropriate. Alternatively, use "etc." with a comma.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D76833/new/

https://reviews.llvm.org/D76833