Skip to content

CONTRIBUTING.rst: options longues dans les blocs de code #1373

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 11, 2020
Merged

CONTRIBUTING.rst: options longues dans les blocs de code #1373

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7b4c3b5
Add missing `code-block`
vpoulailleau Aug 3, 2020
84af653
fix RST syntax
vpoulailleau Aug 9, 2020
4d5849e
options longues pour le bloc de code pomerge
deronnax Aug 9, 2020
0d107fb
les autres
deronnax Aug 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 39 additions & 21 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Cette nouvelle branche nommée « library-sys » est basée sur « upstream/3

.. code-block:: bash

git checkout -b library-sys upstream/3.9
git checkout --branch library-sys upstream/3.9


Vous pouvez maintenant travailler sur le fichier.
Expand Down Expand Up @@ -113,18 +113,21 @@ en anglais.

make spell


Vous pouvez aussi réindenter les fichiers avec :

.. code-block:: bash

make wrap


Et pour faire les deux à la fois, lancez :

.. code-block:: bash

make verifs


Une fois la traduction finie, il faut compiler la documentation, c'est-à-dire générer les fichiers HTML
affichés par le site, pour les relire. Si la commande précédente s'est exécutée sans erreur, la
compilation ne devrait pas échouer.
Expand All @@ -133,13 +136,15 @@ compilation ne devrait pas échouer.

make


Vérifiez alors le rendu de la traduction « en vrai ». Lancez un serveur de
documentation local :

.. code-block:: bash

make serve


La documentation est publiée l'adresse `<http://localhost:8000/library/sys.html>`_
(ou tout autre port indiqué par la sortie de la commande précédente). Vous pouvez
recommencer les étapes de cette section autant de fois que nécessaire.
Expand Down Expand Up @@ -167,7 +172,8 @@ attendant d'être propagées dans le dépôt local.

.. code-block:: bash

git commit -m "Traduction de library/sys.po" # Ou un autre message plus inspiré :)
git commit --message "Traduction de library/sys.po" # Ou un autre message plus inspiré :)


Poussez ensuite vos modifications sur votre *fork* Github avec ``git push``.
Le ``-u`` n'est utile qu'une fois pour que votre client git se souvienne que cette
Expand All @@ -176,7 +182,8 @@ branche est liée à votre *fork* Github (et donc que vos futurs ``git pull`` et

.. code-block:: bash

git push -u origin
git push --set-upstream origin


La commande précédente vous affiche un lien pour ouvrir une pull request sur
Github. Si vous l'avez manqué, allez simplement sur https://github.com/python/python-docs-fr/pulls
Expand All @@ -199,7 +206,7 @@ sur une autre branche) :
# sur l'interface web.

# Réglez les problèmes, puis commitez à nouveau :
git commit -a -m "prise en compte des remarques"
git commit --all --message "prise en compte des remarques"
Comment on lines -202 to +209
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pour moi le -a était un --add, mais non… (en fait je suis un partisan du git add suivi d'un git commit, j'ai tellement vu de gens faire un commit involontaire de fichiers avec ce -a).

Enfin, la PR me semble bonne.

git push


Expand Down Expand Up @@ -321,6 +328,7 @@ utilisés, en prenant garde d'être cohérent. Vous pouvez ainsi traduire :
result = thread.join(timeout=...)
...


en

.. code-block:: python
Expand All @@ -329,6 +337,7 @@ en
resultat = thread.join(timeout=...)
...


mais pas en

.. code-block:: python
Expand All @@ -337,6 +346,7 @@ mais pas en
resultat = fildexécution.attendre(délai=...)
...


Liens hypertextes
+++++++++++++++++

Expand Down Expand Up @@ -538,6 +548,7 @@ Ensuite, dans votre fichier '~/.xsession', ajoutez :
# Gestion des touches clavier
xmodmap $HOME/.Xmodmap


Sous X, avec un bureau graphique, tel que Gnome, ou Xfce, il faut aller
modifier dans les « Paramètres » → « Clavier » → « Disposition » →
« Touche composée ». Pour finir, redémarrez votre session.
Expand Down Expand Up @@ -674,6 +685,7 @@ de ligne, comme :
-#: ../Doc/library/signal.rst:406
+#: ../Doc/library/signal.rst:408


Pour dire à git que ce ne sont pas des informations utiles, vous pouvez faire
ce qui suit après vous être assuré que ``~/.local/bin/`` se trouve dans votre
``PATH``.
Expand Down Expand Up @@ -707,12 +719,14 @@ de ``python-docs-fr`` et certaines s'attendent à trouver un clone de CPython
├── python-docs-fr/
└── cpython/


Pour cloner CPython, vous pouvez utiliser :

.. code-block:: bash

git clone --depth 1 --no-single-branch https://github.com/python/cpython.git


Ceci évite de télécharger tout l'historique (inutile pour générer la
documentation) mais récupère néanmoins toutes les branches.

Expand All @@ -737,25 +751,28 @@ Dans certains cas on a besoin de bouger des traductions d'une branche
- d'une nouvelle branche vers des anciennes branches : pour propager
de temps en temps le travail sur d'anciennes releases (*back porting*).

Pour forward-porter un ou plusieurs commits, il vaut mieux utiliser `git
cherry-pick -x LE_SHA`, ça garde l'auteur, le sha1 d'origine, et
Pour forward-porter un ou plusieurs commits, il vaut mieux utiliser ``git
cherry-pick -x LE_SHA``, ça garde l'auteur, le sha1 d'origine, et
toutes les modifications.

Pour backporter "en gros" on utilise ``pomerge``\  : on le fait lire
Pour backporter « en gros » on utilise ``pomerge``\  : on le fait lire
sur une branche, puis écrire sur une autre, par exemple pour copier de
la 3.8 à la 3.7 ::
la 3.8 à la 3.7 :

.. code-block:: bash

git fetch
git checkout 3.8
git reset --hard upstream/3.8
pomerge --from-files *.po */*.po
git checkout -b back-porting upstream/3.7
git checkout --branch back-porting upstream/3.7
pomerge --no-overwrite --to-files *.po */*.po
powrap -m
powrap --modified
git add --patch
git commit --message="Backporting from 3.8"
git push --set-upstream origin HEAD


Notes :

- j'utilise ``git fetch`` au début pour avoir upstream/3.7 et
Expand Down Expand Up @@ -796,20 +813,21 @@ Propagez d'abord les traductions connues localement :

.. code-block:: bash

pomerge --no-overwrite --from-files **/*.po --to-files **/*.po
powrap --modified
git commit -m "Propagating known translations."
pomerge --no-overwrite --from-files **/*.po --to-files **/*.po
powrap --modified
git commit --message "Propagating known translations."


Ensuite récupérez les changements depuis Transifex :

.. code-block:: bash

tx pull -f --parallel
pomerge --from-files **/*.po
git checkout -- .
pomerge --no-overwrite --mark-as-fuzzy --to-files **/*.po
powrap --modified
git add -p
git commit -m "tx pull"
tx push -t -f --no-interactive --parallel
tx pull -f --parallel
pomerge --from-files **/*.po
git checkout -- .
pomerge --no-overwrite --mark-as-fuzzy --to-files **/*.po
powrap --modified
git add -p
git commit -m "tx pull"
tx push -t -f --no-interactive --parallel