AFPy/python-docs-fr
AFPy/python-docs-fr
Fork 80
Code Issues 6 Pull requests 10 Activity

Make wrap to actually wrap, not just check. (#1765)

Browse source
This commit is contained in:
Julien Palard 2021-11-04 18:14:17 +01:00 • committed by GitHub
commit ff88ce44c3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

29
CONTRIBUTING.rst
View file

@ -141,30 +141,21 @@ Ou lancez simplement Poedit puis « Fichier » → « Ouvrir ».
Traduction
~~~~~~~~~~
Vous pouvez dès à présent commencer à traduire le fichier en respectant les `conventions`_ du projet.
Pour vous aider à ne pas faire de fautes d'orthographe, vous pouvez vérifier que tous les mots utilisés sont
bien dans le dictionnaire (ça ne vérifie pas la grammaire, pour cela utilisez `padpo (beta)`_). En cas
de doute, un `glossaire`_ répertorie déjà les traductions retenues pour certains termes techniques ou faux amis
en anglais.
.. code-block:: bash
make spell
Vous pouvez aussi réindenter les fichiers avec :
.. code-block:: bash
make wrap
Et pour faire les deux à la fois, lancez :
Vous pouvez dès à présent commencer à traduire le fichier en
respectant les `conventions`_ du projet. Pour vous y aider, la commande :
.. code-block:: bash
make verifs
vérifie la longueur des lignes et l'orthographe (mais pas la
grammaire, pour cela utilisez `padpo (beta)`_). En cas de doute, un
`glossaire`_ répertorie déjà les traductions retenues pour certains
termes techniques ou faux amis en anglais.
Si ``make verifs`` trouve des problèmes de longueurs de ligne,
vérifiez votre configuration ``poedit`` (Édition → Préférences →
Avancé → Passer à la ligne à 79) ou utilisez ``make wrap``.
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

9
Makefile
View file

@ -5,7 +5,7 @@
# - make # Automatically build an HTML local version
# - make todo # To list remaining tasks and show current progression
# - make verifs # To check for correctness: wrapping, spelling
# - make wrap # To check for wrapping
# - make wrap # To rewrap modified files
# - make spell # To check for spelling
# - make clean # To remove build artifacts
# - make fuzzy # To find fuzzy strings
@ -106,8 +106,8 @@ todo: ensure_prerequisites
.PHONY: wrap
wrap: ensure_prerequisites
@echo "Verify wrapping"
powrap --check --quiet *.po **/*.po
@echo "Re wrapping modified files"
powrap -m
SRCS = $(shell git diff --name-only $(BRANCH) | grep '.po$$')
# foo/bar.po => $(POSPELL_TMP_DIR)/foo/bar.po.out
@ -126,7 +126,8 @@ fuzzy: ensure_prerequisites
potodo -f --exclude venv .venv $(EXCLUDED)
.PHONY: verifs
verifs: wrap spell
verifs: spell
powrap --check --quiet *.po */*.po
.PHONY: clean
clean: