Add more examples to the NEWS/What's New docs
未关闭
还没有人认领这个 Issue。
good first issue
- 主要语言
- Python
- 星标
- 2.1k
- 派生
- 1k
- 平均合并
- 2 天 12 小时
- 30 天内合并 PR
- 12
描述
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
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
找到 issue 引用的 NEWS/What's New 文档,并审查其中关于何时添加 NEWS 条目的现有指导。添加简洁的正例和反例,包括列出的 Python 发布、文档、测试、private API 和重构案例。验证这些示例能够清晰呈现,并与周围的指导保持一致。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 52/100