Skip to content

Commit 3a7f528

Browse files
m-aciekAA-Turner
andauthored
Add a note about translating code examples (#1382)
Co-authored-by: Adam Turner <[email protected]>
1 parent 3cea249 commit 3a7f528

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

documentation/translating.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,5 +230,13 @@ As for every project, we have a *branch* per version. We store ``.po``
230230
files in the root of the repository using the ``gettext_compact=0``
231231
style.
232232

233+
234+
How should I translate code examples?
235+
-------------------------------------
236+
237+
Translate values in code examples (i.e. string literals) and comments.
238+
Don't translate keywords or names,
239+
including variable, function, class, argument, and attribute names.
240+
233241
.. _translation_wg: https://wiki.python.org/psf/TranslationWG/Charter
234242
.. _translation_ml: https://mail.python.org/mailman3/lists/translation.python.org/

0 commit comments

Comments
 (0)