Clarify when to mark up numeric literals
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
The current devguide recommendations reads:
backquotes: ``text`` for code samples, variables, and literals.
Earlier, I've been corrected to use double backticks when marking up literals. Example PR remark:
Recently, I've seen other styles enforced:
Perhaps we need a clarification, possibly with good/bad examples?
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
Commencez par la section consacrée au balisage de la documentation devguide liée dans l’issue et comparez sa formulation avec les discussions de PR référencées. Mettez à jour les instructions avec des règles claires et de bons/mauvais exemples de littéraux numériques, en montrant que le travail est terminé par une recommandation sans ambiguïté qui résout l’incohérence citée.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- 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