Add more examples to the NEWS/What's New docs
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 2.1k
- Forks
- 1k
- Ø Merge
- 2 T. 12 Std.
- Gemergte PRs (30 T.)
- 12
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Finde die in der Issue referenzierte NEWS-/What's-New-Dokumentation und prüfe ihre aktuellen Hinweise dazu, wann ein NEWS-Eintrag hinzugefügt werden soll. Füge prägnante gute und schlechte Beispiele hinzu, einschließlich der aufgeführten Fälle zu Python-Releases, Dokumentation, Tests, private API und Refactoring. Überprüfe, dass die Beispiele klar dargestellt werden und zu den umgebenden Hinweisen passen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 52/100