8000 Améliorations diverses du README. (#1288) · python/python-docs-fr@e6c0a1b · GitHub
[go: up one dir, main page]

Skip to content

Commit e6c0a1b

Browse files
awecxchristopheNan
andauthored
Améliorations diverses du README. (#1288)
* Modifs mineures. * Corrections mineures. * Modifications diverses. * Encore des modifs. * Correction liste. * Suggestions de ChristopheNan. Co-authored-by: Christophe Nanteuil <35002064+christopheNan@users.noreply.github.com> * Suggestion de christopheNan sur podiff. Co-authored-by: Christophe Nanteuil <35002064+christopheNan@users.noreply.github.com>
1 parent 4a089de commit e6c0a1b

File tree

2 files changed

+75
-59
lines changed

2 files changed

+75
-59
lines changed

CONTRIBUTING.rst

Lines changed: 68 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Prérequis
66

77
- un compte `Github <https://github.com/join>`_ ;
88
- un client ``git`` `Linux <https://git-scm.com/>`_ ou `Windows <https://gitforwindows.org/>`_ ;
9-
- un éditeur de fichier ``.po`` (comme `poedit <https://poedit.net/>`_).
9+
- un éditeur de fichier ``.po`` (comme `Poedit <https://poedit.net/>`_).
1010

1111
Instructions
1212
------------
@@ -20,17 +20,17 @@ où vous avez le droit de faire des modifications.
2020

2121
.. code-block:: bash
2222
23-
# Clonez votre fork Github avec `git` en utilisant ssh :
23+
# Clonez votre fork Github avec `git` en utilisant ssh
2424
git clone git@github.com:VOTRE_NOM_DE_COMPTE_GITHUB/python-docs-fr.git
2525
26-
# *OU* HTTPS :
26+
# ou bien via HTTPS
2727
git clone https://github.com/VOTRE_NOM_DE_COMPTE_GITHUB/python-docs-fr.git
2828
29-
# Allez dans le répertoire cloné :
29+
# Allez dans le répertoire cloné
3030
cd python-docs-fr/
3131
32-
# Ajoutez le dépôt officiel (nommé upstream)
33-
# Ceci permet à *git* de savoir quoi/où est *upstream*
32+
# Ajoutez le dépôt officiel (nommé upstream),
33+
# ceci permet à *git* de savoir quoi et où est *upstream*
3434
git remote add upstream https://github.com/python/python-docs-fr.git
3535
3636
Ensuite, vous devez trouver un fichier sur lequel travailler
@@ -41,17 +41,16 @@ déjà été traduit et ce qui ne l'a pas été).
4141
Une fois que vous avez choisi un fichier sur lequel travailler, veuillez
4242
ouvrir un `ticket sur Github <https://github.com/python/python-docs-fr/issues>`_
4343
en indiquant dans le titre ``Je travaille sur DOSSIER/FICHIER.po``
44-
(par exemple « Je travaille sur library/csv.po »).
44+
(par exemple « Je travaille sur library/sys.po »).
4545
Ceci permet à `potodo`_ de détecter via l'API Github les fichiers ``.po`` réservés
4646
dans les tickets et les *pull requests*.
4747

48-
N'hésitez pas non plus à vous équiper de quelques outils pour vous aider dans
49-
votre traduction (voir `Outils utiles pour la traduction`_)
48+
Équipez-vous aussi de quelques outils pour vous aider dans
49+
votre traduction (voir `Outils utiles pour la traduction`_).
5050

5151
Vous êtes maintenant prêt. Chaque fois que vous commencerez un nouveau fichier,
5252
suivez cette procédure :
5353

54-
5554
Pour travailler, nous aurons besoin d'une branche, basée sur une version à jour
5655
(fraîchement récupérée) de la branche upstream/3.8. On met donc à jour notre
5756
version locale.
@@ -71,22 +70,22 @@ Cette nouvelle branche nommée « library-sys » est basée sur « upstream/3
7170
git checkout -b library-sys upstream/3.8
7271
7372
74-
Vous pouvez maintenant travailler sur le fichier (typiquement, en utilisant poedit).
75-
N'oubliez pas de configurer votre nom et votre email dans Poedit.
76-
(Édition -> Préférences -> Général)
77-
Vérifiez aussi qu'il est configuré pour passer à la ligne à 79 caractères.
78-
(Édition -> Préférences -> Avancé -> Passer à la ligne à : 79)
73+
Vous pouvez maintenant travailler sur le fichier.
74+
Si vous utilisez Poedit, n'oubliez pas de configurer votre nom et votre adresse de courriel
75+
(Édition Préférences Général).
76+
Vérifiez aussi qu'il est configuré pour passer à la ligne à 79 caractères
77+
(Édition Préférences Avancé Passer à la ligne à 79).
7978

8079
Ici, remplacez « library/sys.po » par le fichier que vous avez choisi précédemment.
8180

8281
.. code-block:: bash
8382
8483
poedit library/sys.po
8584
86-
Ou lancez simplement poedit puis « Fichier » → « Ouvrir »
85+
Ou lancez simplement Poedit puis « Fichier » → « Ouvrir ».
8786

88-
Si vous n'utilisez pas poedit, vous pouvez utiliser `powrap <https://github.com/JulienPalard/powrap>`_. (voir la section *outils*)
89-
qui reformate correctement le fichier que avez vous avez modifié.
87+
Si vous n'utilisez pas Poedit, vous pouvez utiliser `powrap <https://github.com/JulienPalard/powrap>`_
88+
(voir la section *outils*) qui reformate correctement le fichier que avez vous avez modifié.
9089
Exécutez `powrap -m` (reformater tous les fichiers modifiés)
9190
ou `powrap library/sys.po` (un fichier en particulier) :
9291

@@ -95,8 +94,8 @@ ou `powrap library/sys.po` (un fichier en particulier) :
9594
powrap -m
9695
9796
Pour l'orthographe, une liste blanche de certains termes techniques ou
98-
de noms propres, comme « Guido », « C99 » ou « sérialisable », est
99-
stockée dans le fichier « dict » à la racine du projet. Vous pouvez
97+
de noms propres, comme « Guido », « C99 » ou « sérialisable », est
98+
stockée dans le fichier « dict » à la racine du projet. Vous pouvez
10099
bien sûr y ajouter une entrée si nécessaire.
101100
La commande suivante lance les vérifications nécessaires.
102101

@@ -105,8 +104,8 @@ La commande suivante lance les vérifications nécessaires.
105104
make verifs
106105
107106
108-
C'est le moment de git add et git commit
109-
git add place nos modifications dans l'index de Git en
107+
C'est le moment de `git add` et `git commit`.
108+
`git add` place nos modifications dans l'index de Git en
110109
attendant d'être propagées dans le dépôt local.
111110

112111
.. code-block:: bash
@@ -135,10 +134,11 @@ Github. Si vous l'avez manqué, allez simplement sur https://github.com/python/p
135134
et un joli bouton « Compare & pull request » devrait apparaître au bout de
136135
quelques secondes vous indiquant que vous pouvez demander une pull request.
137136

138-
Mettez dans le commentaire de la pull request le texte suivant : Fixes #9999 où 9999 est le numéro du ticket GitHub créé pour réserver le fichier traduit.
137+
Mettez dans le commentaire de la pull request le texte suivant :
138+
« Closes #XXXX » où XXXX est le numéro du ticket GitHub créé pour réserver le fichier traduit.
139139

140140
À partir de là, quelqu'un passera en revue vos modifications, et vous fera des
141-
suggestions/corrections. Pour les prendre en compte, retournez sur votre branche
141+
suggestions et corrections. Pour les prendre en compte, retournez sur votre branche
142142
contenant du fichier concerné (au cas où vous auriez commencé quelque chose d'autre
143143
sur une autre branche) :
144144

@@ -183,18 +183,18 @@ Vous pouvez utiliser `potodo`_, un outil fait pour trouver des fichiers ``po``
183183
local.
184184

185185
Vous pouvez choisir n'importe quel fichier non réservé dans la liste
186-
renvoyée par la commande. Cependant, nous vous recommandons de ne **pas**
187-
commencer avec un fichier de ``c-api`` car c'est une partie très technique.
188-
Les anciennes versions de Python sont pour la plupart obsolètes et leurs
189-
journaux de modifications (dans le dossier ``whatsnew``) ne sont pas les pages
190-
les plus consultées. Il y a des fichiers plus prioritaires à traduire.
186+
renvoyée par la commande **à l'exception** des fichiers de :
187+
188+
- ``c-api/`` car c'est une partie très technique ;
189+
- ``whatsnew/`` car les anciennes versions de Python sont pour la plupart obsolètes et leurs journaux de modifications ne sont pas les pages les plus consultées ;
190+
- ``distutils/`` et ``install/`` car ces pages seront bientôt obsolètes.
191191

192192
Vous pouvez commencer par des tâches faciles comme réviser les entrées
193193
*fuzzy* pour aider à garder la documentation à jour (trouvez les entrées
194194
*fuzzy* l'aide de `make fuzzy`).
195195

196196
Vous pouvez également relire des entrées déjà traduites pour vous faire une
197-
idée, et passer ensuite à la traduction de celles qui ne sont pas traduites.
197+
idée, et passer ensuite à la traduction de celles qui ne le sont pas encore.
198198
Vous pouvez les trouver à l'aide de `make todo`…
199199

200200
Vous pouvez aussi « traduire » des liens hypertextes
@@ -210,7 +210,7 @@ Si vous devez absolument utiliser un mot anglais, mettez-le en *italique*
210210
(entouré par des astérisques).
211211

212212
Pour les caractères spéciaux, référez-vous à la section
213-
`Caractères spéciaux`_
213+
`Caractères spéciaux`_.
214214

215215
Conseils
216216
--------
@@ -249,13 +249,22 @@ Dans un souci de lisibilité et en accord avec la préconisation de
249249
l'Académie française, nous utilisons le masculin pour indiquer un
250250
genre neutre. Par exemple : l'utilisateur ou le lecteur.
251251

252+
Style
253+
~~~~~
254+
255+
Une bonne traduction est une traduction qui transcrit fidèlement l'idée originelle
256+
en français, sans rien ajouter ni enlever au fond, tout en restant claire, concise et
257+
agréable à lire. Les traductions mot-à-mot sont à proscrire et il est permis — même
258+
conseillé — d'intervertir des propositions ou de réarranger des phrases de la
259+
documentation anglaise, si le rythme l'exige. Il faut aussi chercher des
260+
équivalents français aux termes techniques et aux idiotismes rencontrés, et prendre
261+
garde aux anglicismes.
252262

253263
Glossaire
254264
~~~~~~~~~
255265

256266
Afin d'assurer la cohérence de la traduction, voici quelques propositions et
257-
rappels pour les termes fréquents à traduire. N'hésitez pas à ouvrir un ticket
258-
si vous n'êtes pas d'accord.
267+
rappels pour les termes fréquents à traduire.
259268

260269
Pour trouver facilement comment un terme est déjà traduit dans la
261270
documentation, vous pouvez utiliser `pogrep`_.
@@ -268,6 +277,7 @@ abstract data type type abstrait
268277
argument argument (à ne pas confondre avec *paramètre*)
269278
backslash antislash, *backslash*
270279
backtrace trace d'appels, trace de pile
280+
backport rétroporter
271281
bound lier
272282
bug bogue
273283
built-in natif
@@ -324,6 +334,7 @@ subprocess sous-processus
324334
support prendre en charge, implémenter (« supporter » n'a
325335
pas le même sens en français)
326336
specify définir, préciser (plutôt que « spécifier »)
337+
typically normalement, habituellement, comme d'habitude (plutôt que « typiquement »)
327338
thread fil d'exécution
328339
traceback trace d'appels, trace de pile
329340
tuple n-uplet
@@ -350,14 +361,14 @@ compositions suivantes :
350361
- :kbd:`Compose SPACE SPACE` donne une espace insécable
351362
- :kbd:`Compose . . .` donne ````
352363

353-
Comme vous l'avez noté, presque toutes les compositions sont faciles
354-
à retenir, vous pouvez donc essayer les autres et elles devraient tout
364+
Comme vous l'avez noté, presque toutes les compositions sont intuitives,
365+
vous pouvez donc en essayer d'autres et elles devraient tout
355366
simplement fonctionner :
356367

357368
- :kbd:`Compose C =` donne ````
358369
- :kbd:`Compose 1 2` donne ``½``
359370
- :kbd:`Compose ' E` donne ``É``
360-
-
371+
- etc.
361372

362373
Comment définir la touche de composition ?
363374
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -390,7 +401,7 @@ Ensuite, dans votre fichier '~/.xsession', ajoutez :
390401
xmodmap $HOME/.Xmodmap
391402
392403
Sous X, avec un bureau graphique, tel que Gnome, ou Xfce, il faut aller
393-
modifier dans les paramètres > clavier > Disposition : puis
404+
modifier dans les « Paramètres » → « Clavier » → « Disposition » →
394405
« Touche composée ». Pour finir, redémarrez votre session.
395406

396407
=> Sous Windows, vous
@@ -399,10 +410,10 @@ pouvez utiliser `wincompose <https://github.com/SamHocevar/wincompose>`_.
399410
Le cas de « --- », « -- », « ... »
400411
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
401412

402-
La version anglaise utilise une chose nommée
413+
La version anglaise utilise les
403414
`smartquotes <http://docutils.sourceforge.net/docs/user/smartquotes.html>`_,
404-
qui fonctionne en anglais, mais cause des problèmes dans d'autres langues.
405-
Nous l'avons donc désactivée dans la version française.
415+
qui fonctionnent en anglais, mais causent des problèmes dans d'autres langues.
416+
Nous les avons donc désactivées (voir #303) dans la version française.
406417

407418
Les *smartquotes* sont normalement responsables de la transformation de
408419
``--`` en *en-dash* (````), de ``---`` en *em-dash* (````), et de
@@ -420,7 +431,7 @@ guillemets anglais ``"``. Cependant, Python utilise les guillemets
420431
anglais comme délimiteurs de chaîne de caractères. Il convient donc de
421432
traduire les guillemets mais pas les délimiteurs de chaîne.
422433

423-
=> Si vous voyez :
434+
=> Si vous voyez :
424435
| « "…" » : faites :kbd:`Compose < <` ou :kbd:`Compose > >`
425436
426437
Le cas de « :: »
@@ -437,7 +448,7 @@ En français, nous mettons une espace insécable devant nos deux-points, comme :
437448
=> Traduisez ``mot deux-points deux-points`` par
438449
``mot espace-insécable deux-points deux-points``.
439450

440-
Pour saisir une espace insécable faites : :kbd:`Compose SPACE SPACE`
451+
Pour saisir une espace insécable faites :kbd:`Compose SPACE SPACE`
441452

442453
Le cas des doubles-espaces
443454
~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -471,7 +482,7 @@ Par exemple :
471482

472483
- le dernier paragraphe.
473484

474-
Malheureusement *poedit* n'aime pas les différences de ponctuation finales
485+
Malheureusement Poedit n'aime pas les différences de ponctuation finales
475486
entre un paragraphe et sa traduction ; il faut passer outre ses avertissements.
476487
Vous pouvez aussi rajouter un commentaire dans le fichier *.po* pour avertir
477488
les traducteurs suivants et éviter qu'ils ne « corrigent » par erreur ces
@@ -494,12 +505,11 @@ Pogrep
494505
| Permet de rechercher dans la documentation des termes. Utile si on a un doute
495506
sur comment traduire un terme ou chercher la traduction d'un terme dans
496507
d'autres fichiers.
497-
| Installez-le à l'aide de *pip* (``pip install pogrep``) dans un
498-
environnement.
508+
| Installez-le à l'aide de *pip* (``pip install pogrep``).
499509
| `Lien vers le dépôt <https://github.com/JulienPalard/pogrep>`__
500510
501511
Padpo (beta)
502-
~~~~~~~~~~~~~~~
512+
~~~~~~~~~~~~
503513

504514
| Analyseur de code qui vérifie la grammaire et l'orthographe et la syntaxe
505515
du fichier .po.
@@ -511,12 +521,11 @@ Powrap
511521
~~~~~~
512522

513523
| Formateur de fichier .po.
514-
| Installez-le à l'aide de *pip* (``pip install powrap``) dans un
515-
environnement.
524+
| Installez-le à l'aide de *pip* (``pip install powrap``).
516525
| `Lien vers le dépôt <https://github.com/JulienPalard/powrap>`__
517526
518527
Ressources de traduction
519-
-------------------------
528+
------------------------
520529

521530
- les canaux IRC sur freenode :
522531

@@ -531,17 +540,21 @@ Ressources de traduction
531540

532541
- le `glossaire de la documentation Python <https://docs.python.org/fr/3/glossary.html>`_, car il est déjà traduit,
533542
- les `glossaires et dictionnaires de traduc.org <https://traduc.org/Glossaires_et_dictionnaires>`_, en particulier le `grand dictionnaire terminologique <http://gdt.oqlf.gouv.qc.ca/>`_ de l'Office québécois de la langue française,
534-
- Wikipédia. En consultant un article sur la version anglaise, puis en basculant sur la version francaise pour voir comment le sujet de l'article est traduit.
543+
- Wikipédia. En consultant un article sur la version anglaise, puis en basculant sur la version francaise pour voir comment le sujet de l'article est traduit ;
535544
- le `guide stylistique pour le français de localisation des produits Sun
536545
<https://web.archive.org/web/20160821182818/http://frenchmozilla.org/FTP/TEMP/guide_stylistique_December05.pdf>`_ donne
537546
beaucoup de conseils pour éviter une traduction trop mot à mot ;
538547
- `Petites leçons de typographie <https://jacques-andre.fr/faqtypo/lessons.pdf>`_,
539548
résumé succint de typographie, utile pour apprendre le bon usage des
540549
majuscules, des espaces, etc.
541550

551+
L'utilisation de traducteurs automatiques comme `DeepL https://www.deepl.com/` ou semi-automatiques comme
552+
`reverso https://context.reverso.net/traduction/anglais-francais/` est proscrite.
553+
Les traductions générées sont très souvent à retravailler, ils ignorent les règles énoncées sur cette
554+
page et génèrent une documentation au style très « lourd ».
542555

543-
Simplifier les diffs git
544-
------------------------
556+
Simplification des diffs git
557+
----------------------------
545558

546559
Les diffs git sont souvent encombrés de changements inutiles de numéros
547560
de ligne, comme :
@@ -567,6 +580,9 @@ ce qui suit après vous être assuré que ``~/.local/bin/`` se trouve dans votre
567580
git config diff.podiff.textconv podiff
568581
569582
583+
Pas d'inquiétude, cela ne change la façon dont Git voit les changements que sur
584+
les fichiers de la traduction, sans incidence sur les autres.
585+
570586
Maintenance
571587
-----------
572588

README.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,11 @@ Comment contribuer
4343
Vous pouvez contribuer :
4444

4545
- en proposant des *pull requests* Github (solution recommandée) ;
46-
- en envoyant un patch à la liste `traductions <https://lists.afpy.org/mailman/listinfo/traductions>`_.
46+
- en envoyant un correctif à la liste `traductions <https://lists.afpy.org/mailman/listinfo/traductions>`_.
4747

48-
Un guide pour contribuer au projet via Github se trouve dans
49-
`CONTRIBUTING.rst
50-
<https://github.com/python/python-docs-fr/blob/3.8/CONTRIBUTING.rst>`_.
48+
Consultez le
49+
`guide <https://github.com/python/python-docs-fr/blob/3.8/CONTRIBUTING.rst>`_
50+
pour apprendre les conventions à respecter.
5151

5252

5353
Où obtenir de l'aide ?
@@ -56,8 +56,8 @@ Où obtenir de l'aide ?
5656
Le coordinateur de cette traduction est `Julien Palard <https://mdk.fr/>`_.
5757

5858
N'hésitez pas à poser vos questions sur le canal ``#python-fr`` sur `freenode
59-
<https://kiwi.freenode.net/>`_ (ne nécessite pas d'inscription) ou sur la
60-
`liste de diffusion des traductions de l'AFPy <https://lists.afpy.org/mailman/listinfo/traductions>`_.
59+
<https://kiwi.freenode.net/>`_ (ne nécessite pas d'inscription) ou par la
60+
`liste de diffusion <https://lists.afpy.org/mailman/listinfo/traductions>`_ des traductions de l'AFPy.
6161

6262

6363
Historique du projet
@@ -70,4 +70,4 @@ l'`AFPy <https://www.afpy.org/>`_. En 2017 ce projet est devenu la
7070
traduction officielle de la documentation Python en français grâce à
7171
la `PEP 545 <https://www.python.org/dev/peps/pep-0545/>`_. `Jules Lasne
7272
<https://github.com/Seluj78>`_ à publié fin 2019 une `vidéo de
73-
l'histoire du dépôt <https://youtu.be/azXmvpEJMhU>`_.
73+
l'histoire du dépôt <https://youtu.be/azXmvpEJMhU>`_.

0 commit comments

Comments
 (0)
0