Skip to content

Commit bcafab8

Browse files
authored
[doc]: Spotted errors while working on rstlint. (GH-30879)
Also ignored some `make suspicious` false positives while assuring true positives were properly seen by rstlint.
1 parent b50322d commit bcafab8

9 files changed

+20
-12
lines changed

Doc/README.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Available make targets are:
9191

9292
* "pydoc-topics", which builds a Python module containing a dictionary with
9393
plain text documentation for the labels defined in
94-
`tools/pyspecific.py` -- pydoc needs these to show topic and keyword help.
94+
``tools/pyspecific.py`` -- pydoc needs these to show topic and keyword help.
9595

9696
* "suspicious", which checks the parsed markup for text that looks like
9797
malformed and thus unconverted reST.

Doc/howto/enum.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ selection of values. For example, the days of the week::
2323
... SATURDAY = 6
2424
... SUNDAY = 7
2525

26-
Or perhaps the RGB primary colors::
26+
Or perhaps the RGB primary colors::
2727

2828
>>> from enum import Enum
2929
>>> class Color(Enum):
@@ -1398,4 +1398,3 @@ Subclassing EnumType
13981398
While most enum needs can be met by customizing :class:`Enum` subclasses,
13991399
either with class decorators or custom functions, :class:`EnumType` can be
14001400
subclassed to provide a different Enum experience.
1401-

Doc/library/email.errors.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -114,4 +114,4 @@ All defect classes are subclassed from :class:`email.errors.MessageDefect`.
114114
a multiple of 4). The encoded block was kept as-is.
115115

116116
* :class:`InvalidDateDefect` -- When decoding an invalid or unparsable date field.
117-
The original value is kept as-is.
117+
The original value is kept as-is.

Doc/library/tk.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,4 @@ alternative `GUI frameworks and tools <https://wiki.python.org/moin/GuiProgrammi
4444

4545
.. Other sections I have in mind are
4646
Tkinter internals
47-
Freezing Tkinter applications
47+
Freezing Tkinter applications

Doc/library/tkinter.colorchooser.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ the :class:`~tkinter.commondialog.Dialog` class.
2626
.. seealso::
2727

2828
Module :mod:`tkinter.commondialog`
29-
Tkinter standard dialog module
29+
Tkinter standard dialog module

Doc/library/tkinter.dnd.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,4 @@ Selection of a target object occurs as follows:
6161

6262
.. seealso::
6363

64-
:ref:`Bindings-and-Events`
64+
:ref:`Bindings-and-Events`

Doc/library/tkinter.messagebox.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,4 @@ limited to:
3636
askokcancel(title=None, message=None, **options)
3737
askretrycancel(title=None, message=None, **options)
3838
askyesno(title=None, message=None, **options)
39-
askyesnocancel(title=None, message=None, **options)
39+
askyesnocancel(title=None, message=None, **options)

Doc/reference/compound_stmts.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ when leaving an exception handler::
313313
keyword: except_star
314314

315315
The :keyword:`except*<except_star>` clause(s) are used for handling
316-
:exc:`ExceptionGroup`s. The exception type for matching is interpreted as in
316+
:exc:`ExceptionGroup`\ s. The exception type for matching is interpreted as in
317317
the case of :keyword:`except`, but in the case of exception groups we can have
318318
partial matches when the type matches some of the exceptions in the group.
319319
This means that multiple except* clauses can execute, each handling part of

Doc/tools/susp-ignored.csv

+12-3
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,10 @@ library/socket,,:can,"return (can_id, can_dlc, data[:can_dlc])"
212212
library/socket,,:len,fds.frombytes(cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])
213213
library/sqlite3,,:year,"cur.execute(""select * from lang where first_appeared=:year"", {""year"": 1972})"
214214
library/sqlite3,,:memory,
215-
library/sqlite3,,:path,"db = sqlite3.connect('file:path/to/database?mode=ro', uri=True)"
215+
library/sqlite3,,:template,"con = sqlite3.connect(""file:template.db?mode=ro"", uri=True)"
216+
library/sqlite3,,:nosuchdb,"con = sqlite3.connect(""file:nosuchdb.db?mode=rw"", uri=True)"
217+
library/sqlite3,,:mem1,"con1 = sqlite3.connect(""file:mem1?mode=memory&cache=shared"", uri=True)"
218+
library/sqlite3,,:mem1,"con2 = sqlite3.connect(""file:mem1?mode=memory&cache=shared"", uri=True)"
216219
library/ssl,,:My,"Organizational Unit Name (eg, section) []:My Group"
217220
library/ssl,,:My,"Organization Name (eg, company) [Internet Widgits Pty Ltd]:My Organization, Inc."
218221
library/ssl,,:myserver,"Common Name (eg, YOUR name) []:myserver.mygroup.myorganization.com"
@@ -379,5 +382,11 @@ library/tkinter,,::,"grid [ttk::button .frm.btn -text ""Quit"" -command ""destro
379382
library/tkinter,,::,ttk::frame
380383
library/tkinter,,::,ttk::button
381384
library/tkinter,,::,ttk::widget
382-
whatsnew/changelog,305,::,Lib/email/mime/nonmultipart.py::MIMENonMultipart
383-
whatsnew/changelog,308,::,Lib/ctypes/test/test_functions.py::test_mro
385+
reference/compound_stmts,324,:exc,subclass of :exc:`BaseExceptionGroup`. It is not possible to mix except
386+
reference/compound_stmts,324,`,subclass of :exc:`BaseExceptionGroup`. It is not possible to mix except
387+
reference/compound_stmts,324,:keyword,"and except* in the same :keyword:`try`. :keyword:`break`,"
388+
reference/compound_stmts,324,`,"and except* in the same :keyword:`try`. :keyword:`break`,"
389+
reference/compound_stmts,324,:keyword,:keyword:`continue` and :keyword:`return` cannot appear in an except*
390+
reference/compound_stmts,324,`,:keyword:`continue` and :keyword:`return` cannot appear in an except*
391+
whatsnew/changelog,178,:CON,": os.path.abspath(“C:CON”) is now fixed to return “\.CON”, not"
392+
whatsnew/changelog,922,::,Lib/email/mime/nonmultipart.py::MIMENonMultipart

0 commit comments

Comments
 (0)