提交Pandas Pull Request前,如何编写bugfix的whatsnew.rst文档并确认目标文件?
正确选择Pandas贡献对应的What's New文件
你的猜测完全正确,应该更新v0.25.0.rst文件,原因如下:
- 从你的环境版本号
pd.__version__ = 0.25.0.dev0+791.gf0919f272.dirty可以看出,当前你处于0.25.0版本的开发阶段:dev0表示这是一个开发预览版,还未正式发布,后面的哈希值是源码的提交标识。Pandas的What's New文件都是对应即将发布的正式版本来记录变更的,所以这个开发版本的修复内容自然要归到v0.25.0.rst中。
接下来给你几个具体的操作建议:
- 打开
doc/source/whatsnew/v0.25.0.rst,找到对应的分类章节(比如Bug Fixes,如果是功能增强就找Enhancements) - 按照贡献指南的要求添加条目,格式示例:
- Fixed a minor bug in [具体模块/功能,比如`DataFrame.merge`] where [简要描述问题,比如`duplicate keys caused unexpected NaN values`]. (:issue: 你的GitHub PR/issue编号) - 如果你不确定条目该放在哪个子章节,可以参考文件中已有的同类修复条目,保持格式一致即可。
补充说明:如果后续0.25.0正式发布,之后的小版本补丁(比如0.25.1)会使用对应的v0.25.1.rst,但当前你的修复属于0.25.0版本的开发迭代内容,所以v0.25.0.rst是正确的选择。
内容的提问来源于stack exchange,提问作者user3556757
相关产品推荐
相关产品推荐

