Skip to content

Commit cbcfd4e

Browse files
committed
i18n: mention "TRANSLATORS:" marker in Documentation/CodingGuidelines
These comments have to have "TRANSLATORS: " at the very beginning and have to deviate from the usual multi-line comment formatting convention. Signed-off-by: Junio C Hamano <[email protected]>
1 parent 47fbfde commit cbcfd4e

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

Documentation/CodingGuidelines

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,16 @@ For C programs:
164164
* multi-line comment.
165165
*/
166166

167+
Note however that a comment that explains a translatable string to
168+
translators uses a convention of starting with a magic token
169+
"TRANSLATORS: " immediately after the opening delimiter, even when
170+
it spans multiple lines. We do not add an asterisk at the beginning
171+
of each line, either. E.g.
172+
173+
/* TRANSLATORS: here is a comment that explains the string
174+
to be translated, that follows immediately after it */
175+
_("Here is a translatable string explained by the above.");
176+
167177
- Double negation is often harder to understand than no negation
168178
at all.
169179

0 commit comments

Comments
 (0)