Skip to content

Commit 6f22c65

Browse files
Maciek's review
1 parent 7e0bbc7 commit 6f22c65

File tree

3 files changed

+43
-40
lines changed

3 files changed

+43
-40
lines changed

documentation/translations/coordinating.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Starting a new translation
1515
First subscribe to the `translation mailing list <translation_ml_>`_,
1616
and introduce yourself and the translation you're starting.
1717

18-
Then you can bootstrap your new translation by using `cookiecutter
19-
<https://github.com/JulienPalard/python-docs-cookiecutter>`__ or
18+
Then you can bootstrap your new translation by using the `cookiecutter
19+
<https://github.com/python-docs-translations/python-docs-cookiecutter>`__ or
2020
`bootstrapper <https://github.com/python-docs-translations/python-docs-bootstrapper>`__.
2121

2222
The important steps look like this:
@@ -144,8 +144,8 @@ style.
144144
Which version of the Python documentation should be translated?
145145
---------------------------------------------------------------
146146

147-
It's best to work on Python's current stable version. You can then propagate your
148-
translation from one branch to another using :pypi:`pomerge`.
147+
It's best to work on Python's current stable or beta version. You can then
148+
propagate your translation from one branch to another using :pypi:`pomerge`.
149149

150150

151151
The entry for my translation is missing or not up to date

documentation/translations/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Translations
33
============
44

55
.. toctree::
6-
:maxdepth: 6
6+
:maxdepth: 3
77

88
translating
99
coordinating

documentation/translations/translating.rst

Lines changed: 38 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -25,22 +25,22 @@ For more details about translations and their progress, see `the dashboard
2525
* - Arabic (ar)
2626
- Abdur-Rahmaan Janhangeer (:github-user:`Abdur-rahmaanJ`)
2727
- :github:`GitHub <Abdur-rahmaanJ/python-docs-ar>`
28-
* - `Bengali (bn_IN) <https://docs.python.org/bn-in/>`__
28+
* - `Bengali (bn-IN) <https://docs.python.org/bn-in/>`__
2929
- Kushal Das (:github-user:`kushaldas`)
3030
- :github:`GitHub <python/python-docs-bn-in>`
3131
* - `French (fr) <https://docs.python.org/fr/>`__
3232
- Julien Palard (:github-user:`JulienPalard`)
3333
- `AFPy/python-docs-fr <https://git.afpy.org/AFPy/python-docs-fr/>`_,
3434
:github:`Mirror <python/python-docs-fr>`
35-
* - `Greek (gr) <https://docs.python.org/gr/>`__
35+
* - `Greek (gr) <https://docs.python.org/el/>`__
3636
- | Lysandros Nikolaou (:github-user:`lysnikolaou`),
3737
| Fanis Petkos (:github-user:`thepetk`),
3838
| Panagiotis Skias (:github-user:`skpanagiotis`)
39-
- :github:`GitHub <pygreece/python-docs-gr>`
39+
- :github:`GitHub <python/python-docs-el>`
4040
* - Hindi (hi-IN)
4141
- Sanyam Khurana (:github-user:`CuriousLearner`)
4242
- :github:`GitHub <CuriousLearner/python-docs-hi-in>`
43-
* - `Hungarian (hu) <https://docs.python.org/hu/>`__ XXX This should probably be added
43+
* - Hungarian (hu)
4444
- Tamás Bajusz (:github-user:`gbtami`)
4545
- :github:`GitHub <python/python-docs-hu>`,
4646
`Mailing list <https://mail.python.org/pipermail/python-hu>`__
@@ -69,7 +69,8 @@ For more details about translations and their progress, see `the dashboard
6969
- Alireza Shabani (:github-user:`revisto`)
7070
- :github:`GitHub <revisto/python-docs-fa>`
7171
* - `Polish (pl) <https://docs.python.org/pl/>`__
72-
- Maciej Olko (:github-user:`m-aciek`)
72+
- | Maciej Olko (:github-user:`m-aciek`)
73+
| Stan Ulbrych (:github-user:`StanFromIreland`)
7374
- :github:`GitHub <python/python-docs-pl>`,
7475
`Transifex <tx_>`_,
7576
`Original announcement <https://mail.python.org/pipermail/doc-sig/2019-April/004106.html>`__
@@ -136,7 +137,7 @@ Translate, don't rewrite
136137
------------------------
137138

138139
Try to stay as close as possible to the original text. Focus on translating its
139-
meaning rather than rephrasing or rewriting it.
140+
meaning in the best possible way, rather than rephrasing or rewriting it.
140141

141142

142143
Gender neutrality
@@ -155,6 +156,8 @@ to other parts of the documentation.
155156
Leave reStructuredText roles such as ``:func:`print``` or ``:ref:`some-section``` in
156157
place, even if they contain section titles, because it will break the link.
157158
If alternate text (``:role:`text <target>``` is provided, it can be translated.
159+
You can also introduce alternate text for translation if the target is not a
160+
name or term.
158161

159162
Links (```text <target>`_``) should be handled similarly. If possible, the target
160163
should be updated to match the language.
@@ -163,34 +166,14 @@ should be updated to match the language.
163166
:doc:`../markup`
164167

165168

166-
Code examples
167-
-------------
168-
169-
Translate values in code examples, that is string literals, and comments.
170-
Don't translate keywords or names, including variable, function, class, argument,
171-
and attribute names. An example of a translated codeblock from the `tutorial <https://docs.python.org/3/tutorial/controlflow.html#keyword-arguments>`_
172-
is provided below:
173-
174-
.. code-block:: python
175-
176-
def cheeseshop(kind, *arguments, **keywords):
177-
print("-- Czy jest może", kind, "?")
178-
print("-- Przykro mi, nie mamy już sera", kind)
179-
for arg in arguments:
180-
print(arg)
181-
print("-" * 40)
182-
for kw in keywords:
183-
print(kw, ":", keywords[kw])
184-
185-
186169
Translation quality
187170
-------------------
188171

189172
Translators should be proficient in both English and the language they are
190173
translating to. Translators should aim for a similar level of quality as that
191174
of the English documentation.
192175

193-
Avoid relying solely on machine translation. These tools can be useful to speed up
176+
Do not rely solely on machine translation. These tools can be useful to speed up
194177
work, but often produce inaccurate or misleading results and should be reviewed
195178
by a human.
196179

@@ -200,20 +183,19 @@ Terminology
200183

201184
The documentation is full of technical terms, some are common in general
202185
programming and have translations, whereas others are specific to Python
203-
and previous translations are not available (remember to check your languages
204-
glossary). Translation teams should keep the translations of these terms
205-
consistent, which is done with glossaries and or translation memory.
186+
and previous translations are not available.
187+
Translation teams should keep the translations of these terms
188+
consistent, which is done with glossaries.
206189

207190
Some general guidelines for deciding on a translation:
208191

209-
- Avoid neologism when possible, use existing community conventions over
210-
inventing new terms.
192+
- Use existing community conventions over inventing new terms.
211193
- You can use a hybrid English form if users are generally familiar
212194
with the English word.
213195
- For common terms, the English word may be best.
214196
- Use other translations as a reference as to what they did for the word.
215197
- Be careful to not translate names.
216-
- Use your best judgment
198+
- Use your best judgment.
217199
- When you translate a specific term, record in glossary to help fellow
218200
translators and ensure consistency.
219201

@@ -226,17 +208,38 @@ understandably the language will differ, it is recommended however that
226208
translators try to keep files and sections consistent.
227209

228210

211+
Code examples
212+
-------------
213+
214+
Translate values in code examples, that is string literals, and comments.
215+
Don't translate keywords or names, including variable, function, class, argument,
216+
and attribute names. An example of a translated codeblock from the `tutorial <https://docs.python.org/3/tutorial/controlflow.html#keyword-arguments>`_
217+
is provided below:
218+
219+
.. code-block:: python
220+
221+
def cheeseshop(kind, *arguments, **keywords):
222+
print("-- Czy jest może", kind, "?")
223+
print("-- Przykro mi, nie mamy już sera", kind)
224+
for arg in arguments:
225+
print(arg)
226+
print("-" * 40)
227+
for kw in keywords:
228+
print(kw, ":", keywords[kw])
229+
230+
229231
Transifex
230232
=========
231233

232234
.. important::
233235

234236
There are many translations in the `python-doc organization on Transifex <tx_>`_,
235-
some of which, however, not used anymore or do not have a coordination team,
237+
some of which, however, are not used or do not have a coordination team,
236238
please confirm this is not the case before you begin translating.
237239

240+
Several language projects use Transifex as their translation interface.
238241
Translations on Transifex are carried out via a web interface, similar to Weblate.
239-
You should translate the **python-newest** project.
242+
You should translate the `python-newest <tx_>`_ project.
240243
If you are new to Transifex, it is recommended that you take the time to read
241244
through the following resources from the Transifex documentation:
242245

0 commit comments

Comments
 (0)