Documenting minimizing diffs for ease of review
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 2.1k
- Forks
- 1k
- Merge moyen
- 2 j 12 h
- PR mergées (30 j)
- 12
Description
Suppose we have some lines that are close to 80 chars long
first text ... end first text.
second text ... end second text.
third text ... end third text.
and if the first line needs some sort of modification that would push it past 80 chars, we can either restructure the entire paragraph of raw rst so it looks tidier, but resulting in 4 lines of git diffs
first text plus some more ...
end first text. second text ...
end second text. third text ...
end third text.
or diffs can be minimized (but with an 'uglier' raw rst), such as like
first text plus some more ...
... end first text.
second text ... end second text.
third text ... end third text.
I think that for ease of reviewing, as well as to maintain a more useful git history, that the second is preferred in general but I haven't found it in the style guide, so maybe it can be added there if there's consensus on it?
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Lisez le guide de style de la documentation indiqué dans l’issue et examinez la discussion existante sur la minimisation des diffs. N’ajoutez des indications que si le projet s’accorde sur cette préférence, avec des exemples montrant le style de retour à la ligne recommandé ; le guide de style doit clairement documenter la convention une fois le travail terminé.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100