Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bpo-42238: [doc]: Spotted errors while working on rstlint. #30879

Merged
merged 1 commit into from
Jan 27, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Doc/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Available make targets are:

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

* "suspicious", which checks the parsed markup for text that looks like
malformed and thus unconverted reST.
Expand Down
3 changes: 1 addition & 2 deletions Doc/howto/enum.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ selection of values. For example, the days of the week::
... SATURDAY = 6
... SUNDAY = 7

Or perhaps the RGB primary colors::
Or perhaps the RGB primary colors::

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

2 changes: 1 addition & 1 deletion Doc/library/email.errors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,4 +114,4 @@ All defect classes are subclassed from :class:`email.errors.MessageDefect`.
a multiple of 4). The encoded block was kept as-is.

* :class:`InvalidDateDefect` -- When decoding an invalid or unparsable date field.
The original value is kept as-is.
The original value is kept as-is.
2 changes: 1 addition & 1 deletion Doc/library/tk.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ alternative `GUI frameworks and tools <https://wiki.python.org/moin/GuiProgrammi

.. Other sections I have in mind are
Tkinter internals
Freezing Tkinter applications
Freezing Tkinter applications
2 changes: 1 addition & 1 deletion Doc/library/tkinter.colorchooser.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ the :class:`~tkinter.commondialog.Dialog` class.
.. seealso::

Module :mod:`tkinter.commondialog`
Tkinter standard dialog module
Tkinter standard dialog module
2 changes: 1 addition & 1 deletion Doc/library/tkinter.dnd.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ Selection of a target object occurs as follows:

.. seealso::

:ref:`Bindings-and-Events`
:ref:`Bindings-and-Events`
2 changes: 1 addition & 1 deletion Doc/library/tkinter.messagebox.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ limited to:
askokcancel(title=None, message=None, **options)
askretrycancel(title=None, message=None, **options)
askyesno(title=None, message=None, **options)
askyesnocancel(title=None, message=None, **options)
askyesnocancel(title=None, message=None, **options)
2 changes: 1 addition & 1 deletion Doc/reference/compound_stmts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ when leaving an exception handler::
keyword: except_star

The :keyword:`except*<except_star>` clause(s) are used for handling
:exc:`ExceptionGroup`s. The exception type for matching is interpreted as in
:exc:`ExceptionGroup`\ s. The exception type for matching is interpreted as in
the case of :keyword:`except`, but in the case of exception groups we can have
partial matches when the type matches some of the exceptions in the group.
This means that multiple except* clauses can execute, each handling part of
Expand Down
15 changes: 12 additions & 3 deletions Doc/tools/susp-ignored.csv
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,10 @@ library/socket,,:can,"return (can_id, can_dlc, data[:can_dlc])"
library/socket,,:len,fds.frombytes(cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])
library/sqlite3,,:year,"cur.execute(""select * from lang where first_appeared=:year"", {""year"": 1972})"
library/sqlite3,,:memory,
library/sqlite3,,:path,"db = sqlite3.connect('file:path/to/database?mode=ro', uri=True)"
library/sqlite3,,:template,"con = sqlite3.connect(""file:template.db?mode=ro"", uri=True)"
library/sqlite3,,:nosuchdb,"con = sqlite3.connect(""file:nosuchdb.db?mode=rw"", uri=True)"
library/sqlite3,,:mem1,"con1 = sqlite3.connect(""file:mem1?mode=memory&cache=shared"", uri=True)"
library/sqlite3,,:mem1,"con2 = sqlite3.connect(""file:mem1?mode=memory&cache=shared"", uri=True)"
library/ssl,,:My,"Organizational Unit Name (eg, section) []:My Group"
library/ssl,,:My,"Organization Name (eg, company) [Internet Widgits Pty Ltd]:My Organization, Inc."
library/ssl,,:myserver,"Common Name (eg, YOUR name) []:myserver.mygroup.myorganization.com"
Expand Down Expand Up @@ -379,5 +382,11 @@ library/tkinter,,::,"grid [ttk::button .frm.btn -text ""Quit"" -command ""destro
library/tkinter,,::,ttk::frame
library/tkinter,,::,ttk::button
library/tkinter,,::,ttk::widget
whatsnew/changelog,305,::,Lib/email/mime/nonmultipart.py::MIMENonMultipart
whatsnew/changelog,308,::,Lib/ctypes/test/test_functions.py::test_mro
reference/compound_stmts,324,:exc,subclass of :exc:`BaseExceptionGroup`. It is not possible to mix except
reference/compound_stmts,324,`,subclass of :exc:`BaseExceptionGroup`. It is not possible to mix except
reference/compound_stmts,324,:keyword,"and except* in the same :keyword:`try`. :keyword:`break`,"
reference/compound_stmts,324,`,"and except* in the same :keyword:`try`. :keyword:`break`,"
reference/compound_stmts,324,:keyword,:keyword:`continue` and :keyword:`return` cannot appear in an except*
reference/compound_stmts,324,`,:keyword:`continue` and :keyword:`return` cannot appear in an except*
whatsnew/changelog,178,:CON,": os.path.abspath(“C:CON”) is now fixed to return “\.CON”, not"
whatsnew/changelog,922,::,Lib/email/mime/nonmultipart.py::MIMENonMultipart