summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2023-08-20 21:08:57 (GMT)
committerGitHub <noreply@github.com>2023-08-20 21:08:57 (GMT)
commita6f15af866c4584b970c72b805a2a4a6f3f63b83 (patch)
tree4e39cf27a12219903c1231be40a48a610316870a
parent399825ed26e0a1873082348f911f34106fc72973 (diff)
downloadcpython-a6f15af866c4584b970c72b805a2a4a6f3f63b83.zip
cpython-a6f15af866c4584b970c72b805a2a4a6f3f63b83.tar.gz
cpython-a6f15af866c4584b970c72b805a2a4a6f3f63b83.tar.bz2
[3.12] Resolve reference warnings in faq/design.rst (GH-108148) (#108180)
Resolve reference warnings in faq/design.rst (GH-108148) (cherry picked from commit 92815cc7cf3df8ab702c7cea4efaef349a4b0480) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
-rw-r--r--Doc/faq/design.rst4
-rw-r--r--Doc/tools/.nitignore1
2 files changed, 2 insertions, 3 deletions
diff --git a/Doc/faq/design.rst b/Doc/faq/design.rst
index 11d0137..ae02c44 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 ba976bc..5a28274 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -25,7 +25,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