[Python-checkins] [doc]: Spotted errors while working on rstlint. (GH-30879)
JulienPalard
webhook-mailer at python.org
Thu Jan 27 02:57:48 EST 2022
https://github.com/python/cpython/commit/bcafab849e9063dd36a7fefb0162e0cf46b3c9b2
commit: bcafab849e9063dd36a7fefb0162e0cf46b3c9b2
branch: main
author: Julien Palard <julien at palard.fr>
committer: JulienPalard <julien at palard.fr>
date: 2022-01-27T08:57:43+01:00
summary:
[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.
files:
M Doc/README.rst
M Doc/howto/enum.rst
M Doc/library/email.errors.rst
M Doc/library/tk.rst
M Doc/library/tkinter.colorchooser.rst
M Doc/library/tkinter.dnd.rst
M Doc/library/tkinter.messagebox.rst
M Doc/reference/compound_stmts.rst
M Doc/tools/susp-ignored.csv
diff --git a/Doc/README.rst b/Doc/README.rst
index 7e8a27b4066d8..c0ac7c4d3d762 100644
--- a/Doc/README.rst
+++ b/Doc/README.rst
@@ -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.
diff --git a/Doc/howto/enum.rst b/Doc/howto/enum.rst
index fa0e2283ebc10..7b1cf75fa81f0 100644
--- a/Doc/howto/enum.rst
+++ b/Doc/howto/enum.rst
@@ -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):
@@ -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.
-
diff --git a/Doc/library/email.errors.rst b/Doc/library/email.errors.rst
index 7a77640571cb1..194a98696f437 100644
--- a/Doc/library/email.errors.rst
+++ b/Doc/library/email.errors.rst
@@ -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.
\ No newline at end of file
+ The original value is kept as-is.
diff --git a/Doc/library/tk.rst b/Doc/library/tk.rst
index 0cb8fda4e32eb..3dc2130539c2c 100644
--- a/Doc/library/tk.rst
+++ b/Doc/library/tk.rst
@@ -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
\ No newline at end of file
+ Freezing Tkinter applications
diff --git a/Doc/library/tkinter.colorchooser.rst b/Doc/library/tkinter.colorchooser.rst
index 60f4d707270d6..6e8479c1dea1e 100644
--- a/Doc/library/tkinter.colorchooser.rst
+++ b/Doc/library/tkinter.colorchooser.rst
@@ -26,4 +26,4 @@ the :class:`~tkinter.commondialog.Dialog` class.
.. seealso::
Module :mod:`tkinter.commondialog`
- Tkinter standard dialog module
\ No newline at end of file
+ Tkinter standard dialog module
diff --git a/Doc/library/tkinter.dnd.rst b/Doc/library/tkinter.dnd.rst
index 6c11c739e1fa1..02de0fd331958 100644
--- a/Doc/library/tkinter.dnd.rst
+++ b/Doc/library/tkinter.dnd.rst
@@ -61,4 +61,4 @@ Selection of a target object occurs as follows:
.. seealso::
- :ref:`Bindings-and-Events`
\ No newline at end of file
+ :ref:`Bindings-and-Events`
diff --git a/Doc/library/tkinter.messagebox.rst b/Doc/library/tkinter.messagebox.rst
index 872e72f7a7e2b..56c1d6c132afd 100644
--- a/Doc/library/tkinter.messagebox.rst
+++ b/Doc/library/tkinter.messagebox.rst
@@ -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)
\ No newline at end of file
+ askyesnocancel(title=None, message=None, **options)
diff --git a/Doc/reference/compound_stmts.rst b/Doc/reference/compound_stmts.rst
index 473f977a4cd9d..c1ee20e5aee62 100644
--- a/Doc/reference/compound_stmts.rst
+++ b/Doc/reference/compound_stmts.rst
@@ -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
diff --git a/Doc/tools/susp-ignored.csv b/Doc/tools/susp-ignored.csv
index cbc3ac0bbab34..43849a409d547 100644
--- a/Doc/tools/susp-ignored.csv
+++ b/Doc/tools/susp-ignored.csv
@@ -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"
@@ -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
More information about the Python-checkins
mailing list