预期构建警告#

在我们的 CI 工作流程中,我们使用一个脚本检查 Sphinx 引发的任何警告,以确保唯一出现的警告是预期警告。 预期警告列表可以在 :code:tests/warning_list.txt 中找到。 要添加新条目,请将警告消息(以 :code:WARNING: 开头的消息)复制粘贴到文件底部。

例如,如果您得到

Unexpected warning: C:\hostedtoolcache\windows\Python\3.9.13\x64\lib\site-packages\pandas\core\frame.py:docstring of pandas.core.frame.DataFrame.groupby:42: WARNING: undefined label: 'groupby.transform'

将以下内容添加到 txt 文件中

WARNING: undefined label: 'groupby.transform'