python / python/cpython

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

Open
#151,946 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs type-bug
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with Doc/library/logging.config.rst and Doc/library/logging.handlers.rst, then run the documentation build that reports the listed Sphinx reference warnings. Review each reported reference and the surrounding documentation, using the linked meta issue for context. Done means both files build without the listed reference warnings; a linked PR is already noted.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.