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

Aperta
#1,243 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
52/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Trova la documentazione NEWS/What's New a cui fa riferimento l'issue e verifica le indicazioni attuali su quando aggiungere una voce NEWS. Aggiungi esempi concisi di casi corretti e scorretti, inclusi i casi elencati relativi alle release di Python, alla documentazione, ai test, a private API e al refactoring. Verifica che gli esempi siano visualizzati chiaramente e corrispondano alle indicazioni circostanti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
Python
Stelle
2.1k
Fork
1k
Merge medio
2g 12h
PR unite (30g)
12

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di python/devguide

Tutte le issue di python/devguide

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.