Replace deprecation lists in whatsnew files with tables
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 77.2k
- Fork
- 35.9k
- Metriche di merge delle PR
- Metriche PR in attesa
Descrizione
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:
- the deprecated/removed API (which links to the API itself using
:func:/:class:/:meth:/etc.) - the version where the deprecation was introduced
- the version where the API is/will be removed (not needed if we have a separate table for each version)
- a link to the PR that introduced the deprecation
- 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)
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia esaminando gli elenchi di deprecation, removal e pending-removal nei file whatsnew, inclusa la pagina 3.13, e analizza l’approccio include-file citato in #122085. Il lavoro è completato quando si è concordata una struttura tabellare e la si applica in modo coerente, preservando le descrizioni necessarie, i link API e le informazioni sulla versione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 25/100