python / python/cpython

Fix all Sphinx reference warnings in `Doc/library/logging.{config,handlers}.rst`

未关闭
#151,946 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

docs type-bug
主要语言
Python
星标
77.2k
派生
35.9k
PR 合并指标
PR 指标待抓取

描述

Bug report

[!IMPORTANT]
See the meta issue for more information.

Doc/library/logging.config.rst
Doc/library/logging.config.rst:53: py:class reference target not found: DictConfigurator [ref.class]
Doc/library/logging.config.rst:53: py:meth reference target not found: configure [ref.meth]
Doc/library/logging.config.rst:53: py:attr reference target not found: dictConfigClass [ref.attr]
Doc/library/logging.config.rst:61: py:attr reference target not found: dictConfigClass [ref.attr]
Doc/library/logging.config.rst:61: py:meth reference target not found: configure [ref.meth]
Doc/library/logging.config.rst:68: py:class reference target not found: DictConfigurator [ref.class]
Doc/library/logging.config.rst:68: py:meth reference target not found: __init__ [ref.meth]
Doc/library/logging.config.rst:68: py:meth reference target not found: configure [ref.meth]
Doc/library/logging.config.rst:68: py:attr reference target not found: dictConfigClass [ref.attr]
Doc/library/logging.config.rst:136: py:const reference target not found: DEFAULT_LOGGING_CONFIG_PORT [ref.const]
Doc/library/logging.config.rst:194: py:meth reference target not found: join [ref.meth]
Doc/library/logging.config.rst:705: py:attr reference target not found: importer [ref.attr]
Doc/library/logging.config.rst:705: py:class reference target not found: DictConfigurator [ref.class]
Doc/library/logging.config.rst:705: py:class reference target not found: BaseConfigurator [ref.class]
Doc/library/logging.handlers.rst
Doc/library/logging.handlers.rst:32: py:meth reference target not found: write [ref.meth]
Doc/library/logging.handlers.rst:32: py:meth reference target not found: flush [ref.meth]
Doc/library/logging.handlers.rst:55: py:meth reference target not found: close [ref.meth]
Doc/library/logging.handlers.rst:160: py:class reference target not found: FileHandler [ref.class]
Doc/library/logging.handlers.rst:221: py:class reference target not found: FileHandler [ref.class]
Doc/library/logging.handlers.rst:289: py:meth reference target not found: emit [ref.meth]
Doc/library/logging.handlers.rst:289: py:meth reference target not found: handleError [ref.meth]
Doc/library/logging.handlers.rst:629: py:const reference target not found: LOG_USER [ref.const]
Doc/library/logging.handlers.rst:847: py:meth reference target not found: __init__ [ref.meth]
Doc/library/logging.handlers.rst:847: py:const reference target not found: DEBUG [ref.const]
Doc/library/logging.handlers.rst:847: py:const reference target not found: INFO [ref.const]
Doc/library/logging.handlers.rst:847: py:const reference target not found: WARNING [ref.const]
Doc/library/logging.handlers.rst:847: py:const reference target not found: ERROR [ref.const]
Doc/library/logging.handlers.rst:847: py:const reference target not found: CRITICAL [ref.const]
Doc/library/logging.handlers.rst:915: py:meth reference target not found: shouldFlush [ref.meth]
Doc/library/logging.handlers.rst:915: py:meth reference target not found: flush [ref.meth]
Doc/library/logging.handlers.rst:949: py:const reference target not found: ERROR [ref.const]
Doc/library/logging.handlers.rst:1088: py:attr reference target not found: msg [ref.attr]
Doc/library/logging.handlers.rst:1088: py:attr reference target not found: message [ref.attr]
Doc/library/logging.handlers.rst:1088: py:attr reference target not found: args [ref.attr]
Doc/library/logging.handlers.rst:1088: py:attr reference target not found: exc_info [ref.attr]
Doc/library/logging.handlers.rst:1088: py:attr reference target not found: exc_text [ref.attr]
Linked PRs
  • gh-152220

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 Doc/library/logging.config.rst 和 Doc/library/logging.handlers.rst 开始,然后运行会报告所列 Sphinx 引用警告的文档构建。使用链接的 meta issue 作为上下文,检查每个报告的引用及其周围的文档。当两个文件都能在没有所列引用警告的情况下完成构建时,即视为完成;已注明一个链接的 PR。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
缺陷
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
描述清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。