Skip to content

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

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.

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 3 commits into from
Nov 4, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
29 changes: 10 additions & 19 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 5 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Copy link
Collaborator

Choose a reason for hiding this comment

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

J'ai dit une bêtise. Il ne faut pas le faire avec -m car nous utilisons tous couramment powrap sur le résultat d'un commit fait sur GitHub, et powrap ne considère pas cela comme un changement dans le dépôt (contrairement à make spell qui regarde la différence avec BRANCH). Donc :

Suggested change
powrap -m
powrap --quiet *.po **/*.po

Copy link
Member Author

Choose a reason for hiding this comment

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

Je pense que la partie make checks / make wrap est plutôt dédiée aux nouveaux. Les anciens connaissent par coeur toutes les options de powrap et n'ont pas besoin du Makefile.

En passant je préfère powrap *.po */*.po à powrap **/*.po, le second risque de trouver des fichiers po dans le venv.

Si vraiment ça te manque, tu pourrais te rajouter make wrapall ?


SRCS = $(shell git diff --name-only $(BRANCH) | grep '.po$$')
# foo/bar.po => $(POSPELL_TMP_DIR)/foo/bar.po.out
Expand All @@ -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:
Expand Down