8000 Typo and grammar fixes to documenting.rst "Translating" section (#698) · python/devguide@fd44d6b · GitHub
[go: up one dir, main page]

Skip to content

Commit fd44d6b

Browse files
authored
Typo and grammar fixes to documenting.rst "Translating" section (#698)
1 parent d355955 commit fd44d6b

File tree

1 file changed

+37
-37
lines changed

1 file changed

+37
-37
lines changed

documenting.rst

Lines changed: 37 additions & 37 deletions
10000
Original file line numberDiff line numberDiff line change
@@ -1586,11 +1586,11 @@ see the make targets above).
15861586
Translating
15871587
===========
15881588

1589-
Python documentation translations are governed by the :PEP:`545`,
1590-
they are built by `docsbuild-scripts
1589+
Python documentation translations are governed by :PEP:`545`.
1590+
They are built by `docsbuild-scripts
15911591
<https://github.com/python/docsbuild-scripts/>`__ and hosted on
15921592
docs.python.org. There are several documentation translations already
1593-
in production, other are work in progress:
1593+
in production; others are works in progress.
15941594

15951595
+-----------------+-------------------------------+----------------------------+
15961596
| Language | Contact | Links |
@@ -1701,16 +1701,16 @@ fall under the aegis of the `PSF Translation Workgroup <translation_wg_>`_
17011701
Then you can bootstrap your new translation by using our `cookiecutter
17021702
<https://github.com/JulienPalard/python-docs-cookiecutter>`__.
17031703

1704-
The important steps looks like this:
1704+
The important steps look like this:
17051705

1706-
- Create the github repo (anywhere), with the right hierarchy (using the
1706+
- Create the GitHub repo (anywhere) with the right hierarchy (using the
17071707
cookiecutter).
1708-
- Gather people to help you translating, you can't do it alone.
1708+
- Gather people to help you translate. You can't do it alone.
17091709
- You can use any tool to translate, as long as you can synchronize with git.
1710-
Some are using Transifex, some are using only github, or you can choose another
1711-
way, it's up to you.
1712-
- Ensure we updated this page to reflect your work and progress, either via a
1713-
PR, or by asking on the `translation mailing list <translation_ml_>`_.
1710+
Some use Transifex, and some use only GitHub. You can choose another
1711+
way if you like; it's up to you.
1712+
- Ensure we update this page to reflect your work and progress, either via a
1713+
PR or by asking on the `translation mailing list <translation_ml_>`_.
17141714
- When ``tutorial/``, ``bugs.py`` and ``library/functions``
17151715
are complete, ask on the `translation mailing list <translation_ml_>`_ for your language to be added in the
17161716
language picker on docs.python.org.
@@ -1722,13 +1722,13 @@ PEP 545 summary:
17221722
Here are the essential points of :PEP:`545`:
17231723

17241724
- Each translation is assigned an appropriate lowercased language tag,
1725-
with an optional region subtag, joined with a dash, like
1725+
with an optional region subtag, and joined with a dash, like
17261726
``pt-br`` or ``fr``.
17271727

1728-
- Each translation is under CC0 and marked as so in the README (as in
1728+
- Each translation is under CC0 and marked as such in the README (as in
17291729
the cookiecutter).
17301730

1731-
- Translations files are hosted on
1731+
- Translation files are hosted on
17321732
``https://github.com/python/python-docs-{LANGUAGE_TAG}`` (not
17331733
mandatory to start a translation, but mandatory to land on
17341734
``docs.python.org``).
@@ -1749,62 +1749,61 @@ and there's a `Libera.Chat IRC <https://libera.chat/>`_ channel,
17491749
Translation FAQ
17501750
---------------
17511751

1752-
Which version of Python documentation should be translated?
1753-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1752+
Which version of the Python documentation should be translated?
1753+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
17541754

1755-
Consensus is to work on current stable, you can then propagate your
1756-
translation from a branch to another using `pomerge
1755+
Consensus is to work on current stable. You can then propagate your
1756+
translation from one branch to another using `pomerge
17571757
<https://pypi.org/project/pomerge/>`__.
17581758

17591759

17601760
Are there some tools to help in managing the repo?
17611761
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
17621762

1763-
Here's what's we're using:
1763+
Here's what we're using:
17641764

1765-
- `pomerge <https://pypi.org/project/pomerge/>`__ to propagate translation
1766-
from a files to others.
1767-
- `pospell <https://pypi.org/project/pospell/>`__ to check for typo in po files.
1765+
- `pomerge <https://pypi.org/project/pomerge/>`__ to propagate translations
1766+
from one file to others.
1767+
- `pospell <https://pypi.org/project/pospell/>`__ to check for typos in ``.po`` files.
17681768
- `powrap <https://pypi.org/project/powrap/>`__ to rewrap the ``.po`` files
1769-
before committing, this helps keeping git diffs short.
1769+
before committing. This helps keep git diffs short.
17701770
- `potodo <https://pypi.org/project/potodo/>`__ to list what needs to be translated.
17711771

17721772

1773-
1774-
How a coordinator is elected?
1773+
How is a coordinator elected?
17751774
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
17761775

1777-
There is no election, each translation have to sort this out. Here are some suggestions.
1776+
There is no election; each translation has to sort this out. Here are some suggestions.
17781777

17791778
- Coordinator requests are to be public on the `translation mailing list <translation_ml_>`_.
1780-
- If the given language have a native core dev, the core dev have its
1781-
word on the choice.
1782-
- Anyone who wants to become coordinator for its native language, and shows
1783-
motivation by translating and building a community, will be named
1779+
- If the given language has a native core dev, the core dev has their
1780+
say on the choice.
1781+
- Anyone who wants to become coordinator for their native language and shows
1782+
motivation by translating and building a community will be named
17841783
coordinator.
17851784
- In case of concurrency between two persons, no one will sort this out
1786-
for you. It is up to you two to organize a local election or whatever
1785+
for you. It is up to you two to organize a local election or whatever is
17871786
needed to sort this out.
1788-
- In case a coordinator become inactive or unreachable for a long
1787+
- If a coordinator becomes inactive or unreachable for a long
17891788
period of time, someone else can ask for a takeover on the `translation mailing list <translation_ml_>`_.
17901789

17911790

17921791
The entry for my translation is missing/not up to date on this page
1793-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1792+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
17941793

17951794
Ask on the `translation mailing list <translation_ml_>`_, or better, make a PR on the `devguide
17961795
<https://github.com/python/devguide/>`__.
17971796

17981797

1799-
I have a translation, but not on git, what should I do?
1800-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1798+
I have a translation, but it's not in git. What should I do?
1799+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
18011800

18021801
You can ask for help on the `translation mailing list <translation_ml_>`_, and
18031802
the team will help you create an appropriate repository. You can still use tools like transifex,
18041803
if you like.
18051804

18061805

1807-
My git hierarchy does not match yours, can I keep it?
1806+
My git hierarchy does not match yours. Can I keep it?
18081807
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
18091808

18101809
No, inside the ``github.com/python`` organization we’ll all have the
@@ -1813,10 +1812,11 @@ translations. So you may have to convert from one hierarchy to another.
18131812
Ask for help on the `translation mailing list <translation_ml_>`_ if you’re
18141813
not sure on how to do it.
18151814

1816-
What hierarchy should I use in my github repository?
1815+
1816+
What hierarchy should I use in my GitHub repository?
18171817
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
18181818

1819-
As for every project, we have a *branch* per version. We store ``po``
1819+
As for every project, we have a *branch* per version. We store ``.po``
18201820
files in the root of the repository using the ``gettext_compact=0``
18211821
style.
18221822

0 commit comments

Comments
 (0)
0