[clang] Clarify use of contractions in diagnostic messages (PR #116803)
via cfe-commits
cfe-commits at lists.llvm.org
Tue Nov 19 06:10:39 PST 2024
================
@@ -160,6 +160,10 @@ wording a diagnostic.
named in a diagnostic message. e.g., prefer wording like ``'this' pointer
cannot be null in well-defined C++ code`` over wording like ``this pointer
cannot be null in well-defined C++ code``.
+* Prefer diagnostic wording without contractions whenever possible. The single
+ quote in a contraction can be visually distracting due to its use with
+ syntactic constructs and contractions can be harder to understand for non-
+ native English speakers.
----------------
Sirraide wrote:
> `cannot` is a formally 'correct' way of saying it
Well, ‘cannot’ and ‘can not’ mean different things, and yeah, usually, ‘cannot’ is what you want. I don’t think ‘can not’ would be too common in a diagnostic because we those are typically not about something you’re allowed not to do...
https://github.com/llvm/llvm-project/pull/116803
More information about the cfe-commits
mailing list