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

Aaron Ballman via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Thu Mar 26 04:50:53 PDT 2020


aaron.ballman added inline comments.


================
Comment at: llvm/docs/CodingStandards.rst:329-330
+context needed to understand what went wrong. Also, to match error message
+styles commonly produced by other tools, start the first sentence with a
+lower-case letter, and finish the last sentence without a period.
+
----------------
This advice is not true for diagnostics from the Clang Static Analyzer, where they've chosen to use sentences with capitalization but without punctuation. We should call that style choice out, and clarify that the lowercase/no punctuation style applies to clang as well as clang-tidy.


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D76833





More information about the llvm-commits mailing list