Skip to content

Conversation

@LamentXU123
Copy link
Contributor

@LamentXU123 LamentXU123 commented Oct 14, 2025

unittest.rst:438: WARNING: py:meth reference target not found: TestCase.__init__ [ref.meth]
unittest.rst:520: WARNING: py:class reference target not found: DocTestSuite [ref.class]
unittest.rst:1025: WARNING: py:attr reference target not found: exception [ref.attr]
unittest.rst:1039: WARNING: py:attr reference target not found: exception [ref.attr]
unittest.rst:1091: WARNING: py:attr reference target not found: warning [ref.attr]
unittest.rst:1091: WARNING: py:attr reference target not found: filename [ref.attr]
unittest.rst:1091: WARNING: py:attr reference target not found: lineno [ref.attr]
unittest.rst:1440: WARNING: py:meth reference target not found: set.difference [ref.meth]
unittest.rst:1648: WARNING: py:meth reference target not found: setUp [ref.meth]
unittest.rst:1657: WARNING: py:meth reference target not found: tearDown [ref.meth]
unittest.rst:1684: WARNING: py:meth reference target not found: defaultTestResult [ref.meth]
unittest.rst:1801: WARNING: py:meth reference target not found: TestSuite._removeTestAtIndex [ref.meth]
unittest.rst:1817: WARNING: py:meth reference target not found: TestSuite._removeTestAtIndex [ref.meth]
unittest.rst:1821: WARNING: py:class reference target not found: TestRunner [ref.class]
unittest.rst:1855: WARNING: py:class reference target not found: testCaseClass [ref.class]
unittest.rst:1858: WARNING: py:meth reference target not found: runTest [ref.meth]
unittest.rst:1908: WARNING: py:mod reference target not found: SampleTests [ref.mod]
unittest.rst:1908: WARNING: py:class reference target not found: SampleTestCase [ref.class]
unittest.rst:1908: WARNING: py:meth reference target not found: test_one [ref.meth]
unittest.rst:1908: WARNING: py:meth reference target not found: test_two [ref.meth]
unittest.rst:1908: WARNING: py:meth reference target not found: test_three [ref.meth]
unittest.rst:1908: WARNING: py:meth reference target not found: test_two [ref.meth]
unittest.rst:2058: WARNING: py:meth reference target not found: TestRunner.run [ref.meth]
unittest.rst:2145: WARNING: py:class reference target not found: TestRunner [ref.class]
unittest.rst:2150: WARNING: py:class reference target not found: TestRunner [ref.class]
unittest.rst:2471: WARNING: py:meth reference target not found: tearDownClass [ref.meth]
unittest.rst:2471: WARNING: py:meth reference target not found: setUpClass [ref.meth]
  • Line 438: ~TestCase.__init__ is undocumented to-be-implemented function
  • line 520: DocTestSuite is referring to doctest.DocTestSuite
  • line 1025: exception is an undocumented attribute of the returned context manager.
  • Line 1039: same as line 1026
  • Line 1091: same. They areundocumented attributes of the returned context manager.
  • Line 1440: the builtin-method set.difference() is document with frozenset.difference together with the reference of frozenset.difference, see here
  • Line 1648, 1657, 1684: the method is inherented from TestCase
  • Line 1801, 1817: Undocumented method of TestSuite, fine to leave it undocumented.
  • Line 1821: The most common implementation of TestRunner is unittest.TextTestRunner. But here it is referring to all TestRunners that include certain methods. So suppressed as undocument class.
  • Line 1855: testCaseClass is undocumented derived class from TestCase
  • Line 1908: Sample tests. Not sure whether it is correct for this to be turned to inline-codeblock or suppressed links.
  • Line 2058, 2145, 2150: Same as line 1821.
  • Line 2471: They are to-be-implemented methods but documented in TestCase. So referring to TestCase.

📚 Documentation preview 📚: https://cpython-previews--140109.org.readthedocs.build/

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news labels Oct 14, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Oct 14, 2025
@hugovk hugovk added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Nov 22, 2025
Co-authored-by: Hugo van Kemenade <[email protected]>
@hugovk hugovk merged commit d4e3829 into python:main Nov 22, 2025
28 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Nov 22, 2025
@hugovk
Copy link
Member

hugovk commented Nov 22, 2025

Thanks!

@miss-islington-app
Copy link

Thanks @LamentXU123 for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 22, 2025
…nGH-140109)

(cherry picked from commit d4e3829)

Co-authored-by: Weilin Du <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Nov 22, 2025

GH-141853 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Nov 22, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 22, 2025
…nGH-140109)

(cherry picked from commit d4e3829)

Co-authored-by: Weilin Du <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Nov 22, 2025

GH-141854 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Nov 22, 2025
hugovk added a commit that referenced this pull request Nov 22, 2025
hugovk added a commit that referenced this pull request Nov 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip news

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants