summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAdam Turner <9087854+AA-Turner@users.noreply.github.com>2023-08-20 18:34:27 (GMT)
committerGitHub <noreply@github.com>2023-08-20 18:34:27 (GMT)
commit92815cc7cf3df8ab702c7cea4efaef349a4b0480 (patch)
tree0279502d8b00305cac9113d3a2937fb1a6f471ef
parentf904aa4e1f6943e5bd9a8a73cf762f063e6fa247 (diff)
downloadcpython-92815cc7cf3df8ab702c7cea4efaef349a4b0480.zip
cpython-92815cc7cf3df8ab702c7cea4efaef349a4b0480.tar.gz
cpython-92815cc7cf3df8ab702c7cea4efaef349a4b0480.tar.bz2
Resolve reference warnings in faq/design.rst (#108148)
-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 ac5b54b..0262a0a 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