Add more examples to the NEWS/What's New docs

Abierto
#1,243 3 comentarios 0 reacciones 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
52/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python
Área
documentation

Línea de trabajo

Busca la documentación de NEWS/What's New a la que hace referencia el issue y revisa sus indicaciones actuales sobre cuándo añadir una entrada de NEWS. Añade ejemplos concisos de casos buenos y malos, incluidos los casos indicados de versiones de Python, documentación, pruebas, private API y refactoring. Verifica que los ejemplos se rendericen claramente y coincidan con las indicaciones circundantes.

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

Descripción

good first issue

I think having a concise list is good, but if we want to elaborate more and clarify we could also provide some examples. An example for this is "a new feature was included in Python 3.13 alpha 1, but got removed in 3.13 beta 2, before the final release of 3.13.".

If we add examples, we could follow the ✔️ good/❌ bad format and do one or two lists with examples like:

✅ the following examples need a NEWS entry:
* a new function, method, class, module
* a new HOWTO in the documentation
* the removal of a deprecated feature
* ...

❌ the following examples *don't* need a NEWS entry:
* a new feature was included in Python 3.13 alpha 1, but got removed in 3.13 beta 2, > before the final release of 3.13
* a typo fix in the documentation or in a docstring
* the addition of a new test method
* the removal of a private and internal API
* code refactoring of a module with no user-visible effects

Originally posted by @ezio-melotti in https://github.com/python/devguide/pull/1238#discussion_r1417763167

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.