Recommended autoformatters?
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 35/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- python
- Domaine
- documentation
Piste de recherche
Commencez dans docs/writing/style.rst, au niveau de la mention existante d’autopep8, puis examinez la comparaison liée entre autopep8, black et yapf. Mettez à jour le document Code Style avec des indications sur ces formateurs et une recommandation ou comparaison claire ; la section doit expliquer comment les développeurs peuvent choisir un autoformatter.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
In the Code Style document https://github.com/realpython/python-guide/blob/master/docs/writing/style.rst there's a small mention of autopep8 which can be used to format code to meet PEP8 standards. But there's at least two other autoformatters (black and yapf) which are as good if not better. There's a blog comparing the three here: https://medium.com/3yourmind/auto-formatters-for-python-8925065f9505
The gist of it is: autopep8 is the most conservative, black is the most opinionated, and yapf is somewhere in between depending on how you configure it.
Should the python guide have an opinion on which auto formatters should be used? In addition to the current mention of autopep8. I think it would be good to expand this section; auto formatters are quite useful and of great interest to developers coming from tools like gofmt and prettier.
- Langage dominant
- Batchfile
- Étoiles
- 29.8k
- Forks
- 5.9k
- Métriques de merge des PR
- Aucune PR mergée en 30 j
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.
Autres issues de realpython/python-guide
-
Page 404 error Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 65/100
realpython/python-guide#1104 · 2 commentaires ·
-
Difficulté 1/5 1-3 heures Accessibilité débutants 62/100
realpython/python-guide#327 ·
-
PyZMQ improvements Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 62/100
realpython/python-guide#326 · 5 commentaires ·
-
@alex Ouverte
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 10/100
realpython/python-guide#1194 ·
-
Development Team SAP Ouverte
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 10/100
realpython/python-guide#1192 ·