[clang] f710e4c - Clarify use of contractions in diagnostic messages (#116803)

[via cfe-commits]

Author: Aaron Ballman
Date: 2024-11-20T08:33:05-05:00
New Revision: f710e4c0219c97d4726742b294446b833e604819

URL: https://github.com/llvm/llvm-project/commit/f710e4c0219c97d4726742b294446b833e604819
DIFF: https://github.com/llvm/llvm-project/commit/f710e4c0219c97d4726742b294446b833e604819.diff

LOG: Clarify use of contractions in diagnostic messages (#116803)

This dissuades contributors from using contractions when writing
diagnostic wording for Clang. Contractions should be avoided because of
the potential for visual confusion with single quoting syntactic
constructs and because they can be harder to understand for non-native
English speakers.

Added: 
    

Modified: 
    clang/docs/InternalsManual.rst

Removed: 
    


################################################################################
diff  --git a/clang/docs/InternalsManual.rst b/clang/docs/InternalsManual.rst
index f189cb4e6a2ac3..39d389b816f129 100644
--- a/clang/docs/InternalsManual.rst
+++ b/clang/docs/InternalsManual.rst
@@ -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.
 
 The Format String
 ^^^^^^^^^^^^^^^^^