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
分支
36k
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 摘要。