Skip to content

Commit 4a2673a

Browse files
committed
Clarify use of contractions in diagnostic messages
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.
1 parent 3130691 commit 4a2673a

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

clang/docs/InternalsManual.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,10 @@ wording a diagnostic.
160160
named in a diagnostic message. e.g., prefer wording like ``'this' pointer
161161
cannot be null in well-defined C++ code`` over wording like ``this pointer
162162
cannot be null in well-defined C++ code``.
163+
* Prefer diagnostic wording without contractions whenever possible. The single
164+
quote in a contraction can be visually distracting due to its use with
165+
syntactic constructs and contractions can be harder to understand for non-
166+
native English speakers.
163167

164168
The Format String
165169
^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)