Clarify when to mark up numeric literals

Abierto
#1,312 4 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
45/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Área
documentation

Línea de trabajo

Comienza con la sección de marcado de la documentación de devguide enlazada en el issue y compara su redacción con las discusiones de PR referenciadas. Actualiza la guía con reglas claras y ejemplos buenos/malos de literales numéricos, dejando claro que se ha completado mediante una recomendación inequívoca que resuelva la inconsistencia citada.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

needs: decision topic-documentation

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?

Lenguaje dominante
Python
Estrellas
2.1k
Forks
1k
Merge medio
2 d 12 h
PR fusionados (30 d)
12

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de python/devguide

Todos los issues de python/devguide

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.