[Python-checkins] Resolve reference warnings in faq/design.rst (#108148)

hugovk webhook-mailer at python.org
Sun Aug 20 14:34:31 EDT 2023


https://github.com/python/cpython/commit/92815cc7cf3df8ab702c7cea4efaef349a4b0480
commit: 92815cc7cf3df8ab702c7cea4efaef349a4b0480
branch: main
author: Adam Turner <9087854+AA-Turner at users.noreply.github.com>
committer: hugovk <hugovk at users.noreply.github.com>
date: 2023-08-20T12:34:27-06:00
summary:

Resolve reference warnings in faq/design.rst (#108148)

files:
M Doc/faq/design.rst
M Doc/tools/.nitignore

diff --git a/Doc/faq/design.rst b/Doc/faq/design.rst
index 11d01374dc1e7..ae02c443e5938 100644
--- a/Doc/faq/design.rst
+++ b/Doc/faq/design.rst
@@ -584,9 +584,9 @@ exhaustive test suites that exercise every line of code in a module.
 An appropriate testing discipline can help build large complex applications in
 Python as well as having interface specifications would.  In fact, it can be
 better because an interface specification cannot test certain properties of a
-program.  For example, the :meth:`list.append` method is expected to add new elements
+program.  For example, the :meth:`!list.append` method is expected to add new elements
 to the end of some internal list; an interface specification cannot test that
-your :meth:`list.append` implementation will actually do this correctly, but it's
+your :meth:`!list.append` implementation will actually do this correctly, but it's
 trivial to check this property in a test suite.
 
 Writing test suites is very helpful, and you might want to design your code to
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index ac5b54b38f37c..0262a0afe4546 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -24,7 +24,6 @@ Doc/c-api/typeobj.rst
 Doc/c-api/unicode.rst
 Doc/extending/extending.rst
 Doc/extending/newtypes.rst
-Doc/faq/design.rst
 Doc/faq/gui.rst
 Doc/faq/library.rst
 Doc/glossary.rst



More information about the Python-checkins mailing list