python / python/cpython

Fix all Sphinx reference warnings in `Doc/library/email.{charset,parser}.rst`

Open
#151,947 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs topic-email 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/email.charset.rst
Doc/library/email.charset.rst:184: py:meth reference target not found: Charset.convert [ref.meth]
Doc/library/email.parser.rst
Doc/library/email.parser.rst:51: py:mod reference target not found: email.feedparser [ref.mod]
Linked PRs
  • gh-151966
  • gh-152178

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/email.charset.rst:184 and Doc/library/email.parser.rst:51, then run the documentation reference-warning check for these files. Confirm that the Charset.convert and email.feedparser references resolve without warnings; linked PRs gh-151966 and gh-152178 indicate the work is already underway.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.