From 5a4c9bb7fef5e10fd8d64e40a3a00854b7ef3b85 Mon Sep 17 00:00:00 2001 From: antoine Date: Sat, 16 May 2020 23:30:32 +0200 Subject: [PATCH 01/19] make et make serve --- CONTRIBUTING.rst | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index d07655495..f97cbb2d8 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -103,6 +103,23 @@ La commande suivante lance les vérifications nécessaires. make verifs +Nous pouvons alors compiler la documentation, c'est-à-dire générer les fichiers HTML +utilisés par le site. Si la commande précédente s'est exécutée sans erreur, la +compilation ne devrait pas échouer. + +.. code-block:: bash + + make + +Il faut alors vérifier le rendu de la traduction « en vrai ». Lancez un serveur de +documentation local : + +.. code-block:: bash + + make serve + +Pour afficher la documentation, ouvrez l'adresse ``_ +(ou tout autre port indiqué par la sortie de la commande précédente). C'est le moment de `git add` et `git commit`. `git add` place nos modifications dans l'index de Git en @@ -606,8 +623,8 @@ 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. -Fusionner les fichiers *pot* de CPython -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Fusion des fichiers *pot* de CPython +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: bash @@ -630,6 +647,15 @@ Lancer un *build* en local make +Lancer un serveur de documentation en local +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: bash + + make serve + + + Synchroniser la traduction avec Transifex ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From bcd9ed12050750a9cbf6b7f13b790bcb77623c32 Mon Sep 17 00:00:00 2001 From: antoine Date: Sun, 17 May 2020 12:35:06 +0200 Subject: [PATCH 02/19] Modifications diverses. --- CONTRIBUTING.rst | 41 +++++++++++++++++++++++++---------------- 1 file changed, 25 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index f97cbb2d8..94350c001 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -93,32 +93,35 @@ ou `powrap library/sys.po` (un fichier en particulier) : powrap -m +Vous pouvez commencer à présent commencer à traduire le fichier. +N'oubliez pas de respecter les `Conventions` du projet. + Pour l'orthographe, une liste blanche de certains termes techniques ou de noms propres, comme « Guido », « C99 » ou « sérialisable », est stockée dans le fichier « dict » à la racine du projet. Vous pouvez bien sûr y ajouter une entrée si nécessaire. -La commande suivante lance les vérifications nécessaires. +La commande suivante lance les vérifications nécessaires : .. code-block:: bash make verifs -Nous pouvons alors compiler la documentation, c'est-à-dire générer les fichiers HTML -utilisés par le site. Si la commande précédente s'est exécutée sans erreur, la +Une fois la traduction finie, il faut compiler la documentation, c'est-à-dire générer les fichiers HTML +utilisé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. .. code-block:: bash make -Il faut alors vérifier le rendu de la traduction « en vrai ». Lancez un serveur de +Vérifiez alors le rendu de la traduction « en vrai ». Lancez un serveur de documentation local : .. code-block:: bash make serve -Pour afficher la documentation, ouvrez l'adresse ``_ +La documentation est publiée l'adresse ``_ (ou tout autre port indiqué par la sortie de la commande précédente). C'est le moment de `git add` et `git commit`. @@ -196,7 +199,7 @@ Que traduire ? ~~~~~~~~~~~~~~ Vous pouvez utiliser `potodo`_, un outil fait pour trouver des fichiers ``po`` -à traduire. Une fois installé, utilisez la commande ``potodo`` dans votre clone +à traduire. Une fois installé, utilisez la commande ``make todo`` dans votre clone local. Vous pouvez choisir n'importe quel fichier non réservé dans la liste @@ -207,18 +210,18 @@ renvoyée par la commande **à l'exception** des fichiers de : - ``distutils/`` et ``install/`` car ces pages seront bientôt obsolètes. Vous pouvez commencer par des tâches faciles comme réviser les entrées -*fuzzy* pour aider à garder la documentation à jour (trouvez les entrées -*fuzzy* l'aide de `make fuzzy`). +*fuzzy* pour aider à garder la documentation à jour (trouvez-les à l'aide +de `make fuzzy`). Une entrée *fuzzy* correspond à une entrée déjà traduite +mais dont la source en aglais a été remodifiée depuis (correction orthographique, +changement d'un terme, ajout ou suppression d'une phrase…). Elles sont +généralement « faciles » à traduire. Vous pouvez également relire des entrées déjà traduites pour vous faire une idée, et passer ensuite à la traduction de celles qui ne le sont pas encore. -Vous pouvez les trouver à l'aide de `make todo`… -Vous pouvez aussi « traduire » des liens hypertextes -(par exemple s'il s'agit d'un lien vers un article de Wikipédia qui possède une -traduction). -Modifiez le lien et sa description dans ce cas. -Si aucune traduction de la cible n'existe, ne traduisez pas le titre. + +Conventions +----------- Dans les fichiers, ne traduisez pas le contenu des balises telles que ``:ref :...`` et ``:term :...``. @@ -229,8 +232,14 @@ Si vous devez absolument utiliser un mot anglais, mettez-le en *italique* Pour les caractères spéciaux, référez-vous à la section `Caractères spéciaux`_. -Conseils --------- +Liens hypertextes +~~~~~~~~~~~~~~~~~ + +Il faut « traduire » les liens hypertextes (par exemple s'il s'agit d'un +lien vers un article de Wikipédia qui possède une traduction). +Modifiez le lien et sa description dans ce cas. +Si aucune traduction de la cible n'existe, ne traduisez pas le titre. + Utilisation du futur ~~~~~~~~~~~~~~~~~~~~ From 77c2d09c6bbbe82e806cc6ccc63330d846bc6dce Mon Sep 17 00:00:00 2001 From: antoine Date: Sun, 17 May 2020 12:46:00 +0200 Subject: [PATCH 03/19] =?UTF-8?q?R=C3=A9organisation=20des=20sections.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.rst | 55 ++++++++++++++++++++++++++++++++---------------- 1 file changed, 37 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 94350c001..907c02533 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,15 +1,22 @@ Guide de contribution à la documention via GitHub. ================================================== +Instructions +------------ + Prérequis ---------- +~~~~~~~~~ - un compte `Github `_ ; - un client ``git`` `Linux `_ ou `Windows `_ ; - un éditeur de fichier ``.po`` (comme `Poedit `_). -Instructions ------------- +Équipez-vous aussi de quelques outils pour vous aider dans +votre traduction (voir `Outils utiles pour la traduction`_). + + +*fork* personnel +~~~~~~~~~~~~~~~ Pour commencer vous aurez besoin de *forker* le dépôt des sources `python-docs-fr `_ en cliquant sur son bouton @@ -33,6 +40,10 @@ où vous avez le droit de faire des modifications. # ceci permet à *git* de savoir quoi et où est *upstream* git remote add upstream https://github.com/python/python-docs-fr.git + +Réservation d'un fichier +~~~~~~~~~~~~~~~~~~~~~~~~ + Ensuite, vous devez trouver un fichier sur lequel travailler (pour vous aiguiller, vous pouvez vous rendre à `Que traduire ?`_ et lire les explications concernant `potodo`_ qui vous permettra de voir ce qui a @@ -45,9 +56,6 @@ en indiquant dans le titre ``Je travaille sur DOSSIER/FICHIER.po`` Ceci permet à `potodo`_ de détecter via l'API Github les fichiers ``.po`` réservés dans les tickets et les *pull requests*. -Équipez-vous aussi de quelques outils pour vous aider dans -votre traduction (voir `Outils utiles pour la traduction`_). - Vous êtes maintenant prêt. Chaque fois que vous commencerez un nouveau fichier, suivez cette procédure : @@ -82,6 +90,7 @@ Ici, remplacez « library/sys.po » par le fichier que vous avez choisi préc poedit library/sys.po + Ou lancez simplement Poedit puis « Fichier » → « Ouvrir ». Si vous n'utilisez pas Poedit, vous pouvez utiliser `powrap `_ @@ -93,6 +102,10 @@ ou `powrap library/sys.po` (un fichier en particulier) : powrap -m + +Traduction +~~~~~~~~~~ + Vous pouvez commencer à présent commencer à traduire le fichier. N'oubliez pas de respecter les `Conventions` du projet. @@ -122,7 +135,11 @@ documentation local : make serve La documentation est publiée l'adresse ``_ -(ou tout autre port indiqué par la sortie de la commande précédente). +(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. + +*pull request* +~~~~~~~~~~~~~~ C'est le moment de `git add` et `git commit`. `git add` place nos modifications dans l'index de Git en @@ -164,7 +181,7 @@ sur une autre branche) : .. code-block:: bash - git checkout library/sys + git checkout library-sys git pull # pour rapatrier les modifications que vous auriez acceptées # sur l'interface web. @@ -196,7 +213,7 @@ les plus anciennes par l'`équipe de documentation `_. Que traduire ? -~~~~~~~~~~~~~~ +-------------- Vous pouvez utiliser `potodo`_, un outil fait pour trouver des fichiers ``po`` à traduire. Une fois installé, utilisez la commande ``make todo`` dans votre clone @@ -240,7 +257,6 @@ lien vers un article de Wikipédia qui possède une traduction). Modifiez le lien et sa description dans ce cas. Si aucune traduction de la cible n'existe, ne traduisez pas le titre. - Utilisation du futur ~~~~~~~~~~~~~~~~~~~~ @@ -368,8 +384,8 @@ underscore tiret bas, *underscore* whitespace caractère d'espacement ========================== =============================================== -Caractères spéciaux -------------------- +Caractères spéciaux et typographie +---------------------------------- La touche de composition ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -550,6 +566,7 @@ Powrap | Installez-le à l'aide de *pip* (``pip install powrap``). | `Lien vers le dépôt `__ + Ressources de traduction ------------------------ @@ -579,6 +596,7 @@ L'utilisation de traducteurs automatiques comme `DeepL https://www.deepl.com/` o Les traductions générées sont très souvent à retravailler, ils ignorent les règles énoncées sur cette page et génèrent une documentation au style très « lourd ». + Simplification des diffs git ---------------------------- @@ -609,6 +627,7 @@ ce qui suit après vous être assuré que ``~/.local/bin/`` se trouve dans votre Pas d'inquiétude, cela ne change la façon dont Git voit les changements que sur les fichiers de la traduction, sans incidence sur les autres. + Maintenance ----------- @@ -648,16 +667,16 @@ Trouver les chaînes de caractères *fuzzy* make fuzzy -Lancer un *build* en local -~~~~~~~~~~~~~~~~~~~~~~~~~~ +*build* local +~~~~~~~~~~~~~ .. code-block:: bash make -Lancer un serveur de documentation en local -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Serveur de documentation en local +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: bash @@ -665,8 +684,8 @@ Lancer un serveur de documentation en local -Synchroniser la traduction avec Transifex -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Synchronisation de la traduction avec Transifex +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Vous aurez besoin de ``transifex-client`` et ``powrap``, depuis PyPI. From 41d6bca6c8bc10d330166e96de92409fd168b114 Mon Sep 17 00:00:00 2001 From: antoine Date: Sun, 17 May 2020 12:50:42 +0200 Subject: [PATCH 04/19] Modif mineure. --- CONTRIBUTING.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 907c02533..f12db4d73 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -45,9 +45,9 @@ Réservation d'un fichier ~~~~~~~~~~~~~~~~~~~~~~~~ Ensuite, vous devez trouver un fichier sur lequel travailler -(pour vous aiguiller, vous pouvez vous rendre à `Que traduire ?`_ et lire -les explications concernant `potodo`_ qui vous permettra de voir ce qui a -déjà été traduit et ce qui ne l'a pas été). +(pour vous aiguiller, lisez la section `Que traduire ?`_). Nous vous conseillons +de choisir, si possible, un fichier traitant d'un sujet que vous maitrisez, cela +vous aidera grandement à produire une traduction de bonne qualité. Une fois que vous avez choisi un fichier sur lequel travailler, veuillez ouvrir un `ticket sur Github `_ From fa2be08263174a4b12e7c0d465d3177409ef2fa0 Mon Sep 17 00:00:00 2001 From: antoine Date: Sun, 17 May 2020 12:57:15 +0200 Subject: [PATCH 05/19] =?UTF-8?q?Modif=20mineures=20sur=20une=20=C3=A9num?= =?UTF-8?q?=C3=A9ration.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.rst | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index f12db4d73..a64228b05 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -229,7 +229,7 @@ renvoyée par la commande **à l'exception** des fichiers de : Vous pouvez commencer par des tâches faciles comme réviser les entrées *fuzzy* pour aider à garder la documentation à jour (trouvez-les à l'aide de `make fuzzy`). Une entrée *fuzzy* correspond à une entrée déjà traduite -mais dont la source en aglais a été remodifiée depuis (correction orthographique, +mais dont la source en anglais a été remodifiée depuis (correction orthographique, changement d'un terme, ajout ou suppression d'une phrase…). Elles sont généralement « faciles » à traduire. @@ -240,14 +240,11 @@ idée, et passer ensuite à la traduction de celles qui ne le sont pas encore. Conventions ----------- -Dans les fichiers, ne traduisez pas le contenu des balises telles que -``:ref :...`` et ``:term :...``. - -Si vous devez absolument utiliser un mot anglais, mettez-le en *italique* -(entouré par des astérisques). - -Pour les caractères spéciaux, référez-vous à la section -`Caractères spéciaux`_. +- dans les fichiers, ne traduisez pas le contenu des balises telles que +``:ref :...`` et ``:term :...`` ; +- si vous devez absolument utiliser un mot anglais, mettez-le en *italique* +(entouré par des astérisques) ; +- pour les caractères spéciaux, référez-vous à la section `Caractères spéciaux et typographie`_. Liens hypertextes ~~~~~~~~~~~~~~~~~ From fc98297f34c9e4b3951653c8cc3000c8307bce0c Mon Sep 17 00:00:00 2001 From: Antoine <43954001+awecx@users.noreply.github.com> Date: Sun, 17 May 2020 17:05:45 +0200 Subject: [PATCH 06/19] Suggestions de christopheNan Co-authored-by: Christophe Nanteuil <35002064+christopheNan@users.noreply.github.com> --- CONTRIBUTING.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index a64228b05..48c276003 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -107,7 +107,7 @@ Traduction ~~~~~~~~~~ Vous pouvez commencer à présent commencer à traduire le fichier. -N'oubliez pas de respecter les `Conventions` du projet. +N'oubliez pas de respecter les `Conventions`_ du projet. Pour l'orthographe, une liste blanche de certains termes techniques ou de noms propres, comme « Guido », « C99 » ou « sérialisable », est @@ -120,7 +120,7 @@ La commande suivante lance les vérifications nécessaires : make verifs Une fois la traduction finie, il faut compiler la documentation, c'est-à-dire générer les fichiers HTML -utilisés par le site pour les relire. Si la commande précédente s'est exécutée sans erreur, la +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. .. code-block:: bash @@ -231,7 +231,7 @@ Vous pouvez commencer par des tâches faciles comme réviser les entrées de `make fuzzy`). Une entrée *fuzzy* correspond à une entrée déjà traduite mais dont la source en anglais a été remodifiée depuis (correction orthographique, changement d'un terme, ajout ou suppression d'une phrase…). Elles sont -généralement « faciles » à traduire. +généralement « plus faciles » à traduire. Vous pouvez également relire des entrées déjà traduites pour vous faire une idée, et passer ensuite à la traduction de celles qui ne le sont pas encore. @@ -241,9 +241,9 @@ Conventions ----------- - dans les fichiers, ne traduisez pas le contenu des balises telles que -``:ref :...`` et ``:term :...`` ; + ``:ref :...`` et ``:term :...`` ; - si vous devez absolument utiliser un mot anglais, mettez-le en *italique* -(entouré par des astérisques) ; + (entouré par des astérisques) ; - pour les caractères spéciaux, référez-vous à la section `Caractères spéciaux et typographie`_. Liens hypertextes @@ -621,7 +621,7 @@ ce qui suit après vous être assuré que ``~/.local/bin/`` se trouve dans votre git config diff.podiff.textconv podiff -Pas d'inquiétude, cela ne change la façon dont Git voit les changements que sur +Pas d'inquiétude, cela ne change la façon dont Git affiche les changements que sur les fichiers de la traduction, sans incidence sur les autres. From a9765ac4e147dfca506065d30a69be624f120163 Mon Sep 17 00:00:00 2001 From: antoine Date: Mon, 18 May 2020 19:52:36 +0200 Subject: [PATCH 07/19] Modifs mineures. --- CONTRIBUTING.rst | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 48c276003..f24a69848 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,5 +1,5 @@ -Guide de contribution à la documention via GitHub. -================================================== +Guide de contribution à la documention via GitHub +================================================= Instructions ------------ @@ -20,7 +20,7 @@ votre traduction (voir `Outils utiles pour la traduction`_). Pour commencer vous aurez besoin de *forker* le dépôt des sources `python-docs-fr `_ en cliquant sur son bouton -``Fork``. Ceci crée une copie du projet sur votre compte Github : un endroit +``Fork``. Ceci crée une copie du projet sur votre compte Github, c'est un endroit où vous avez le droit de faire des modifications. Étape par étape : @@ -106,8 +106,7 @@ ou `powrap library/sys.po` (un fichier en particulier) : Traduction ~~~~~~~~~~ -Vous pouvez commencer à présent commencer à traduire le fichier. -N'oubliez pas de respecter les `Conventions`_ du projet. +Vous pouvez commencer à présent commencer à traduire le fichier en respectant les `Conventions`_ du projet. Pour l'orthographe, une liste blanche de certains termes techniques ou de noms propres, comme « Guido », « C99 » ou « sérialisable », est @@ -160,7 +159,7 @@ Puis on propage les modifications dans le dépôt local avec un commit. Poussez ensuite vos modifications sur votre fork Github. Le -u n'est utile qu'une fois pour que votre client git se souvienne que cette branche est liée à votre fork Github (et donc que vos futurs `git pull` et -`git push` sachent quoi tirer) +`git push` sachent quoi tirer). .. code-block:: bash From 75b5fa59436bdb453ce785e633f2c6f2181f5530 Mon Sep 17 00:00:00 2001 From: antoine Date: Mon, 18 May 2020 20:11:23 +0200 Subject: [PATCH 08/19] =?UTF-8?q?Ajout=20d'une=20sous-section=20sur=20les?= =?UTF-8?q?=20param=C3=A8tres=20de=20fonction.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.rst | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index f24a69848..264a8e1fa 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -239,12 +239,44 @@ idée, et passer ensuite à la traduction de celles qui ne le sont pas encore. Conventions ----------- -- dans les fichiers, ne traduisez pas le contenu des balises telles que + +- dans les fichiers, ne traduisez pas le contenu des balises comme que ``:ref :...`` et ``:term :...`` ; - si vous devez absolument utiliser un mot anglais, mettez-le en *italique* (entouré par des astérisques) ; - pour les caractères spéciaux, référez-vous à la section `Caractères spéciaux et typographie`_. +Prototypes et exemples +~~~~~~~~~~~~~~~~~~~~~~ + +Il ne faut pas traduire le nom des paramètres d'une méthode ou d'une fonction mais les +laisser tels quel entourés d'astérisques. +Si la documentation contient des exemples, vous *pouvez* traduire les noms de variables +utilisés, en prenant garde d'être cohérent. Vous pouvez ainsi traduire : + +.. code-block:: python + + def sample_function(): + result = stdlib_function(keyword_arg=...) + ... + +en + +.. code-block:: python + + def fonction_exemple(): + resultat = stdlib_function(keyword_arg=...) + ... + +mais pas en + +.. code-block:: python + + def fonction_exemple(): + resultat = function_de_la_biliotheque(argument_nomme=...) + ... + + Liens hypertextes ~~~~~~~~~~~~~~~~~ From bb1d380514bb964018b0b0f0761897a79893ddbf Mon Sep 17 00:00:00 2001 From: antoine Date: Mon, 18 May 2020 21:04:43 +0200 Subject: [PATCH 09/19] =?UTF-8?q?Encore=20quelques=20am=C3=A9liorations.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.rst | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 264a8e1fa..e553b9e72 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -108,10 +108,6 @@ Traduction Vous pouvez commencer à présent commencer à traduire le fichier en respectant les `Conventions`_ du projet. -Pour l'orthographe, une liste blanche de certains termes techniques ou -de noms propres, comme « Guido », « C99 » ou « sérialisable », est -stockée dans le fichier « dict » à la racine du projet. Vous pouvez -bien sûr y ajouter une entrée si nécessaire. La commande suivante lance les vérifications nécessaires : .. code-block:: bash @@ -240,12 +236,6 @@ Conventions ----------- -- dans les fichiers, ne traduisez pas le contenu des balises comme que - ``:ref :...`` et ``:term :...`` ; -- si vous devez absolument utiliser un mot anglais, mettez-le en *italique* - (entouré par des astérisques) ; -- pour les caractères spéciaux, référez-vous à la section `Caractères spéciaux et typographie`_. - Prototypes et exemples ~~~~~~~~~~~~~~~~~~~~~~ @@ -330,17 +320,28 @@ documentation anglaise, si le rythme l'exige. Il faut aussi chercher des équivalents français aux termes techniques et aux idiotismes rencontrés, et prendre garde aux anglicismes. +Balises +~~~~~~~ + +Ne traduisez pas le contenu des balises comme ``:ref :...`` ou ``:term :...``. + + Glossaire ~~~~~~~~~ -Afin d'assurer la cohérence de la traduction, voici quelques propositions et -rappels pour les termes fréquents à traduire. +Afin d'assurer la cohérence de la traduction, voici quelques +termes fréquents déjà traduits. Une liste blanche de noms propres, comme « Guido », +« C99 » ou de certains anglicismes comme « sérialisable » ou « implémentation», +est stockée dans le fichier « dict » à la racine du projet. Vous pouvez +y ajouter une entrée si cela est nécessaire. +Si vous devez *absolument* utiliser un mot anglais, mettez-le en italique +(entouré par des astérisques). Pour trouver facilement comment un terme est déjà traduit dans la documentation, vous pouvez utiliser `pogrep`_. ========================== =============================================== -Terme Traduction proposée +Terme Traduction ========================== =============================================== -like -compatible abstract data type type abstrait From 0dc9e98c4d3ab6e2547ed49c065b8bb7285af68f Mon Sep 17 00:00:00 2001 From: antoine Date: Mon, 18 May 2020 21:06:02 +0200 Subject: [PATCH 10/19] Test. --- CONTRIBUTING.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index e553b9e72..bd898f432 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -323,7 +323,7 @@ garde aux anglicismes. Balises ~~~~~~~ -Ne traduisez pas le contenu des balises comme ``:ref :...`` ou ``:term :...``. +Ne traduisez pas le contenu des balises comme ``:ref\ :...`` ou ``:term:...``. Glossaire From 4660624a52df90e7938330d7861e6698bf867636 Mon Sep 17 00:00:00 2001 From: antoine Date: Mon, 18 May 2020 21:13:09 +0200 Subject: [PATCH 11/19] =?UTF-8?q?Ajout=20d'une=20section=20=C2=AB=20balise?= =?UTF-8?q?s=20=C2=BB.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.rst | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index bd898f432..d62fac6c4 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -323,7 +323,22 @@ garde aux anglicismes. Balises ~~~~~~~ -Ne traduisez pas le contenu des balises comme ``:ref\ :...`` ou ``:term:...``. +Ne traduisez pas le contenu des balises comme ``:ref:...`` ou ``:class:...``. +Vous devez cependant traduire les balises ``:term:...``, qui font référence à +un concept ou une primitive Python défini dans le glossaire. La correspondance +doit se faire sous la forme ``:term:nom_français`` Par exemple, +traduisez + +.. code-block:: rst + :term:`dictionary` + +en + +.. code-block:: rst + :term:`dictionaire ` + +Comme le glossaire est déjà traduit, il y a forcément une correspondance à chaque +terme que vous pouvez rencontrer. Glossaire From c9e3e955ab9a2aa832c735a8b1d398a8b2693104 Mon Sep 17 00:00:00 2001 From: antoine Date: Mon, 18 May 2020 21:17:39 +0200 Subject: [PATCH 12/19] Ajout d'un lien dans la section balise. --- CONTRIBUTING.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index d62fac6c4..ba8706fe1 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -325,16 +325,16 @@ Balises Ne traduisez pas le contenu des balises comme ``:ref:...`` ou ``:class:...``. Vous devez cependant traduire les balises ``:term:...``, qui font référence à -un concept ou une primitive Python défini dans le glossaire. La correspondance -doit se faire sous la forme ``:term:nom_français`` Par exemple, -traduisez +un concept ou une primitive Python défini dans le `glossaire `_. +La syntaxe est ``:term:nom_français``. Par exemple, traduisez : -.. code-block:: rst +`_. +.. code-block:: bash :term:`dictionary` en -.. code-block:: rst +.. code-block:: bash :term:`dictionaire ` Comme le glossaire est déjà traduit, il y a forcément une correspondance à chaque From 67153ba9e74b95b5a2359a4a5eb27c177f2434f1 Mon Sep 17 00:00:00 2001 From: antoine Date: Mon, 18 May 2020 21:19:05 +0200 Subject: [PATCH 13/19] Correction dans la section balise. --- CONTRIBUTING.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index ba8706fe1..00a05219d 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -328,13 +328,14 @@ Vous devez cependant traduire les balises ``:term:...``, qui font référence à un concept ou une primitive Python défini dans le `glossaire `_. La syntaxe est ``:term:nom_français``. Par exemple, traduisez : -`_. .. code-block:: bash + :term:`dictionary` en .. code-block:: bash + :term:`dictionaire ` Comme le glossaire est déjà traduit, il y a forcément une correspondance à chaque From 1c8feaf25e9aba5314515e30db9060f476fa00e4 Mon Sep 17 00:00:00 2001 From: antoine Date: Mon, 18 May 2020 21:21:21 +0200 Subject: [PATCH 14/19] Test. --- CONTRIBUTING.rst | 13 ++----------- 1 file changed, 2 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 00a05219d..cee951e5f 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -326,17 +326,8 @@ Balises Ne traduisez pas le contenu des balises comme ``:ref:...`` ou ``:class:...``. Vous devez cependant traduire les balises ``:term:...``, qui font référence à un concept ou une primitive Python défini dans le `glossaire `_. -La syntaxe est ``:term:nom_français``. Par exemple, traduisez : - -.. code-block:: bash - - :term:`dictionary` - -en - -.. code-block:: bash - - :term:`dictionaire ` +La syntaxe est ``:term:nom_français``. Par exemple, traduisez +``:term:\`dictionary\``` en ``:term:`dictionaire ``` Comme le glossaire est déjà traduit, il y a forcément une correspondance à chaque terme que vous pouvez rencontrer. From 77d76925804a1eb578138d7b4f9c88269d003482 Mon Sep 17 00:00:00 2001 From: antoine Date: Mon, 18 May 2020 21:27:55 +0200 Subject: [PATCH 15/19] =?UTF-8?q?Derni=C3=A8res=20modifs.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.rst | 60 +++++++++++++++++++++++------------------------- 1 file changed, 29 insertions(+), 31 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index cee951e5f..98a64f00c 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -235,7 +235,6 @@ idée, et passer ensuite à la traduction de celles qui ne le sont pas encore. Conventions ----------- - Prototypes et exemples ~~~~~~~~~~~~~~~~~~~~~~ @@ -266,7 +265,6 @@ mais pas en resultat = function_de_la_biliotheque(argument_nomme=...) ... - Liens hypertextes ~~~~~~~~~~~~~~~~~ @@ -275,6 +273,29 @@ lien vers un article de Wikipédia qui possède une traduction). Modifiez le lien et sa description dans ce cas. Si aucune traduction de la cible n'existe, ne traduisez pas le titre. +Balises +~~~~~~~ + +Ne traduisez pas le contenu des balises comme ``:ref:...`` ou ``:class:...``. +Vous devez cependant traduire les balises ``:term:...``, qui font référence à +un concept ou une primitive Python défini dans le `glossaire `_. +La syntaxe est ``:term:nom_français``. Par exemple, traduisez +``:term:`dictionary``` en ``:term:`dictionaire ``` + +Comme le glossaire est déjà traduit, il y a forcément une correspondance à chaque +terme que vous pouvez rencontrer. + +Style +~~~~~ + +Une bonne traduction est une traduction qui transcrit fidèlement l'idée originelle +en français, sans rien ajouter ni enlever au fond, tout en restant claire, concise et +agréable à lire. Les traductions mot-à-mot sont à proscrire et il est permis — même +conseillé — d'intervertir des propositions ou de réarranger des phrases de la +documentation anglaise, si le rythme l'exige. Il faut aussi chercher des +équivalents français aux termes techniques et aux idiotismes rencontrés, et prendre +garde aux anglicismes. + Utilisation du futur ~~~~~~~~~~~~~~~~~~~~ @@ -309,30 +330,6 @@ Dans un souci de lisibilité et en accord avec la préconisation de l'Académie française, nous utilisons le masculin pour indiquer un genre neutre. Par exemple : l'utilisateur ou le lecteur. -Style -~~~~~ - -Une bonne traduction est une traduction qui transcrit fidèlement l'idée originelle -en français, sans rien ajouter ni enlever au fond, tout en restant claire, concise et -agréable à lire. Les traductions mot-à-mot sont à proscrire et il est permis — même -conseillé — d'intervertir des propositions ou de réarranger des phrases de la -documentation anglaise, si le rythme l'exige. Il faut aussi chercher des -équivalents français aux termes techniques et aux idiotismes rencontrés, et prendre -garde aux anglicismes. - -Balises -~~~~~~~ - -Ne traduisez pas le contenu des balises comme ``:ref:...`` ou ``:class:...``. -Vous devez cependant traduire les balises ``:term:...``, qui font référence à -un concept ou une primitive Python défini dans le `glossaire `_. -La syntaxe est ``:term:nom_français``. Par exemple, traduisez -``:term:\`dictionary\``` en ``:term:`dictionaire ``` - -Comme le glossaire est déjà traduit, il y a forcément une correspondance à chaque -terme que vous pouvez rencontrer. - - Glossaire ~~~~~~~~~ @@ -384,8 +381,8 @@ i.e. c.-à-d. (on n'utilise pas l'anglicisme « i.e. », identifier identifiant immutable immuable import importation -index indice (en particulier quand on parle de chaînes de - caractères) +index indice (en particulier quand on parle de chaînes + de caractères) installer installateur interpreter interpréteur library bibliothèque @@ -409,10 +406,11 @@ simple quote guillemet simple socket connecteur ou interface de connexion statement instruction subprocess sous-processus -support prendre en charge, implémenter (« supporter » n'a - pas le même sens en français) +support prendre en charge, implémenter (« supporter » + n'a pas le même sens en français) specify définir, préciser (plutôt que « spécifier ») -typically normalement, habituellement, comme d'habitude (plutôt que « typiquement ») +typically normalement, habituellement, comme d'habitude + (plutôt que « typiquement ») thread fil d'exécution traceback trace d'appels, trace de pile tuple n-uplet From 8ec87f37931c5d55453fed803dbb877f996f0152 Mon Sep 17 00:00:00 2001 From: antoine Date: Mon, 18 May 2020 21:42:17 +0200 Subject: [PATCH 16/19] =?UTF-8?q?Ajout=20URL=20dans=20la=20section=20?= =?UTF-8?q?=C2=AB=20liens=20hypertextes=20=C2=BB.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 98a64f00c..ec51e6534 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -272,6 +272,9 @@ Il faut « traduire » les liens hypertextes (par exemple s'il s'agit d'un lien vers un article de Wikipédia qui possède une traduction). Modifiez le lien et sa description dans ce cas. Si aucune traduction de la cible n'existe, ne traduisez pas le titre. +Par exemple vous pouvez traduire ``Conway's Game of Life `` +en ``https://fr.wikipedia.org/wiki/Jeu_de_la_vie`` + Balises ~~~~~~~ @@ -280,7 +283,7 @@ Ne traduisez pas le contenu des balises comme ``:ref:...`` ou ``:class:...``. Vous devez cependant traduire les balises ``:term:...``, qui font référence à un concept ou une primitive Python défini dans le `glossaire `_. La syntaxe est ``:term:nom_français``. Par exemple, traduisez -``:term:`dictionary``` en ``:term:`dictionaire ``` +``:term:`dictionary``` en ``:term:`dictionaire ```. Comme le glossaire est déjà traduit, il y a forcément une correspondance à chaque terme que vous pouvez rencontrer. From 3abde9041e763f996f11596bb1b3206dad3737bb Mon Sep 17 00:00:00 2001 From: antoine Date: Mon, 18 May 2020 21:45:07 +0200 Subject: [PATCH 17/19] =?UTF-8?q?Modif.=20URL=20dans=20la=20section=20?= =?UTF-8?q?=C2=AB=20liens=20hypertextes=20=C2=BB.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index ec51e6534..81d06afd6 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -272,8 +272,8 @@ Il faut « traduire » les liens hypertextes (par exemple s'il s'agit d'un lien vers un article de Wikipédia qui possède une traduction). Modifiez le lien et sa description dans ce cas. Si aucune traduction de la cible n'existe, ne traduisez pas le titre. -Par exemple vous pouvez traduire ``Conway's Game of Life `` -en ``https://fr.wikipedia.org/wiki/Jeu_de_la_vie`` +Par exemple vous pouvez traduire ```Conway's Game of Life `_`` +en ```Jeu de la vie `_``. Balises From b27e2b575037df7e5aa305ecdd5c30c5b949a9b0 Mon Sep 17 00:00:00 2001 From: Antoine <43954001+awecx@users.noreply.github.com> Date: Fri, 22 May 2020 21:22:11 +0200 Subject: [PATCH 18/19] Apply suggestions from deronnax. Co-authored-by: Mathieu Dupuy --- CONTRIBUTING.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 81d06afd6..86a409f7b 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -226,7 +226,7 @@ Vous pouvez commencer par des tâches faciles comme réviser les entrées de `make fuzzy`). Une entrée *fuzzy* correspond à une entrée déjà traduite mais dont la source en anglais a été remodifiée depuis (correction orthographique, changement d'un terme, ajout ou suppression d'une phrase…). Elles sont -généralement « plus faciles » à traduire. +généralement plus « faciles » à traduire. Vous pouvez également relire des entrées déjà traduites pour vous faire une idée, et passer ensuite à la traduction de celles qui ne le sont pas encore. From f79463152a5223a11b26c596975742d7caa911c6 Mon Sep 17 00:00:00 2001 From: antoine Date: Fri, 22 May 2020 21:39:45 +0200 Subject: [PATCH 19/19] Remarques de deronnax. --- CONTRIBUTING.rst | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 81d06afd6..0ae17a6b2 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -238,15 +238,16 @@ Conventions Prototypes et exemples ~~~~~~~~~~~~~~~~~~~~~~ -Il ne faut pas traduire le nom des paramètres d'une méthode ou d'une fonction mais les -laisser tels quel entourés d'astérisques. -Si la documentation contient des exemples, vous *pouvez* traduire les noms de variables +Il ne faut pas traduire le nom des éléments de la bibliothèque standard (noms +de fonctions, paramètres de ces fonctions, constantes etc.) mais les laisser +tels quel, entourés d'astérisques dans les blocs de texte. +Si la documentation contient des exemples, vous *pouvez* traduire les noms utilisés, en prenant garde d'être cohérent. Vous pouvez ainsi traduire : .. code-block:: python def sample_function(): - result = stdlib_function(keyword_arg=...) + result = thread.join(timeout=...) ... en @@ -254,7 +255,7 @@ en .. code-block:: python def fonction_exemple(): - resultat = stdlib_function(keyword_arg=...) + resultat = thread.join(timeout=...) ... mais pas en @@ -262,18 +263,18 @@ mais pas en .. code-block:: python def fonction_exemple(): - resultat = function_de_la_biliotheque(argument_nomme=...) + resultat = fildexécution.attendre(délai=...) ... Liens hypertextes ~~~~~~~~~~~~~~~~~ -Il faut « traduire » les liens hypertextes (par exemple s'il s'agit d'un -lien vers un article de Wikipédia qui possède une traduction). -Modifiez le lien et sa description dans ce cas. -Si aucune traduction de la cible n'existe, ne traduisez pas le titre. -Par exemple vous pouvez traduire ```Conway's Game of Life `_`` -en ```Jeu de la vie `_``. +Il faut transformer les liens hypertextes qui redirigent vers une page dont il +existe une version française (c'est notamment très souvent le cas pour les +articles de Wikipédia). Modifiez le lien *et* sa description dans ce cas. +Si aucune traduction de la cible n'existe, ne traduisez pas la description. +Par exemple, ```Conway's Game of Life `_`` +doit devenir ```Jeu de la vie `_``. Balises