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

[James Henderson via Phabricator via llvm-commits]

jhenderson marked an inline comment as done.
jhenderson added inline comments.


================
Comment at: llvm/docs/CodingStandards.rst:338
+
+  error: file.o: section header 3 is corrupt. Size is 10 when it should be 20
+
----------------
rnk wrote:
> If you look at clang diagnostics, I think most of the time we would use a semicolon to separate sentences here, so it would look like this:
>   error: file.o: section header 3 is corrupt; size is 10 when it should be 20
> 
> However, overall this is useful guidance, and if you want to leave this example as is for migrating existing multi-sentence diagnostics, that's OK with me.
Thanks for the comment. I think there's less clear consensus in the tools on what to do about mid-message ends of sentences. I know that there are several messages following `<part1>. <part2>` style and also `<part1>: <part2>` etc. Let's leave this as is for now.


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D76833