python / python/cpython

Replace deprecation lists in whatsnew files with tables

Abierto
#122,652 2 comentarios 2 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

docs
Lenguaje dominante
Python
Estrellas
77.2k
Forks
35.9k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

Documentation

The whatsnew files currently contain lists of removals, deprecations, and pending removals (see e.g. https://docs.python.org/3.13/whatsnew/3.13.html#new-deprecations). These tables are not particularly easy to navigate and take enough space (~1/3?) that they make the whatsnew itself difficult to navigate too.

I would consider replacing them with one or more tables.

The columns could include:

  1. the deprecated/removed API (which links to the API itself using :func:/:class:/:meth:/etc.)
  2. the version where the deprecation was introduced
  3. the version where the API is/will be removed (not needed if we have a separate table for each version)
  4. a link to the PR that introduced the deprecation
  5. possibly the contributor

The table won't contain the full description that explains why it was deprecated and how to replace it, making the table more compact and easier to navigate than the list we currently have. This will also saves us from (near) duplicating the description in both the .. deprecated:: directive in the modules pages and in the whatsnew.

Most deprecated APIs are seldomly used and don't affect many users. If they do, they are probably just a small fraction of all the deprecations, so all the text in the list is not particularly useful. It's also easier to run the code and see the deprecation warnings/errors or quickly scan a table than scanning a long list of deprecations.

The table is still convenient for checking if anything I'm using has been deprecated, for ctrl+f'ing deprecated APIs as I'm fixing them, for finding links to the APIs, and for reviewing the versions where they will be removed.

Some notes about using tables:

  • Some deprecation require short description (e.g. "Passing more than one positional argument to sqlite3.connect()"). There are possible solutions to this:
    • don't elaborate further and just link to the API that contains the deprecation notice
    • have a column for the "affect API" and a "note" column where to add a short description (if needed)
    • only use the tables for deprecated APIs, leaving the rest as a list
  • The name/link to the API already contains the module name, but a separate column for the module might be easier to read
  • If we have different tables depending on the version the APIs is being removed, then we won't need a column for it.
  • Like the lists, the tables can be included in multiple whatsnew files using include files (see #122085)

(cc @hugovk, @AA-Turner, @encukou)

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.

Línea de trabajo

Empieza revisando las listas de deprecation, removal y pending-removal en los archivos whatsnew, incluida la página 3.13, e inspecciona el enfoque de include-file mencionado en #122085. Se considera terminado cuando se haya acordado una estructura de tabla y se aplique de forma coherente, conservando las descripciones necesarias, los enlaces de API y la información de versión.

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

Evaluación

Stack tecnológico
python
Área
documentation
Tipo de issue
Documentación
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.